2010YOUY01 opened a new pull request, #25102:
URL: https://github.com/apache/datafusion/pull/25102

   ## Which issue does this PR close?
   
   - Closes #25101.
   
   ## 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`:
   
   ```rust
   /// Set [`repartition_joins`]
   ///
   /// [`repartition_joins`]: 
datafusion_common::config::OptimizerOptions::repartition_joins
   ```
   
   Behavior that belongs to the wrapper rather than the field is kept as a 
short note (`with_batch_size` panics on zero, `with_target_partitions` treats 
zero as "use the default").
   
   A follow-up PR does the same for `ParquetFormat` in 
`datafusion-datasource-parquet`.
   
   ## What is the testing strategy for this PR?
   
   Doc-comment only change. Verified the intra-doc links resolve with 
`RUSTDOCFLAGS="-D warnings" cargo doc --document-private-items --no-deps -p 
datafusion-execution` (the same check `ci/scripts/rust_docs.sh` runs).
   
   ## Are there any user-facing changes?
   
   Rustdoc only. No API changes.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to