Skip to content

docs: Point SessionConfig setter/getter docs to the config definitions - #25102

Open
2010YOUY01 wants to merge 1 commit into
apache:mainfrom
2010YOUY01:config-doc-session-config
Open

docs: Point SessionConfig setter/getter docs to the config definitions#25102
2010YOUY01 wants to merge 1 commit into
apache:mainfrom
2010YOUY01:config-doc-session-config

Conversation

@2010YOUY01

@2010YOUY01 2010YOUY01 commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

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. Some SessionConfig setters/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 SessionConfig setter/getter that wraps a single config field now uses the same pattern already used by with_target_partitions / target_partitions:

/// Set [`repartition_joins`]
///
/// [`repartition_joins`]: datafusion_common::config::OptimizerOptions::repartition_joins

What is the testing strategy for this PR?

NA

Are there any user-facing changes?

NO

@github-actions github-actions Bot added the execution Related to the execution crate label Sep 9, 2026
@2010YOUY01
2010YOUY01 marked this pull request as draft September 9, 2026 07:54
@2010YOUY01
2010YOUY01 marked this pull request as ready for review September 9, 2026 08:07
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.80%. Comparing base (bf01e28) to head (50aaca4).
⚠️ Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

execution Related to the execution crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clean-up config setter/getter doc comments

2 participants