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

   ## Which issue does this PR close?
   
   - Part of #25101.
   
   ## Rationale for this change
   
   Same motivation as #25101: a configuration option's main documentation 
should live on the config field definition, since the user guide is generated 
from there. The `ParquetFormat` setters/getters in 
`datafusion-datasource-parquet` wrap fields of `ParquetOptions` but 
re-explained them independently. Some of that text was already stale (e.g. "If 
`None`, defaults to value on `config_options`" on `bool` setters), and 
`coerce_int96` / `with_coerce_int96` had no docs at all.
   
   This is a follow-up to the `SessionConfig` PR for the same issue.
   
   ## What changes are included in this PR?
   
   - `ParquetFormat` setters/getters now just link to the corresponding 
`ParquetOptions` field, following the same pattern as `SessionConfig`.
   - The performance rationale that only existed on the `force_view_types` / 
`binary_as_string` getters (why view types and UTF-8 reads are faster) is moved 
onto the `schema_force_view_types` / `binary_as_string` field docs in 
`datafusion_common::config`, so it is not lost and now also shows up in the 
user guide.
   - `docs/source/user-guide/configs.md` regenerated with 
`dev/update_config_docs.sh`.
   
   ## 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` for 
`datafusion-datasource-parquet` (with the `parquet_encryption` feature, as the 
workspace build enables) and `datafusion-common`. Ran 
`dev/update_config_docs.sh` and `ci/scripts/doc_prettier_check.sh`.
   
   ## Are there any user-facing changes?
   
   Two rows in the configuration user guide gain an extra sentence of 
explanation. 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