docs: Point SessionConfig setter/getter docs to the config definitions - #25102
Open
2010YOUY01 wants to merge 1 commit into
Open
docs: Point SessionConfig setter/getter docs to the config definitions#251022010YOUY01 wants to merge 1 commit into
2010YOUY01 wants to merge 1 commit into
Conversation
2010YOUY01
marked this pull request as draft
September 9, 2026 07:54
2010YOUY01
marked this pull request as ready for review
September 9, 2026 08:07
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #25102 +/- ##
==========================================
- Coverage 81.80% 81.80% -0.01%
==========================================
Files 1130 1130
Lines 417707 417708 +1
Branches 417707 417708 +1
==========================================
- Hits 341708 341687 -21
- Misses 55875 55890 +15
- Partials 20124 20131 +7 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
A configuration option's main documentation lives on the config field definition in
datafusion_common::config, since the user guide (https://datafusion.apache.org/user-guide/configs.html) is generated from there. SomeSessionConfigsetters/getters re-explained the option in their own words, which drifts from the definition over time (and in some cases already had). Keeping the wrapper docs as a plain link to the definition keeps the documentation centralized.What changes are included in this PR?
Every
SessionConfigsetter/getter that wraps a single config field now uses the same pattern already used bywith_target_partitions/target_partitions:What is the testing strategy for this PR?
NA
Are there any user-facing changes?
NO