2010YOUY01 opened a new issue, #25101:
URL: https://github.com/apache/datafusion/issues/25101

   ### Is your feature request related to a problem or challenge?
   
   A configuration option's main documentation should live in the comment on 
the config definition, since the docs are auto-generated from there: 
https://datafusion.apache.org/user-guide/configs.html
   
   The setters and getters for a configuration option should simply point to 
the config field, so the documentation stays centralized.
   
https://github.com/apache/datafusion/blob/35c56b020e190126f45395a217d47475f5f6f020/datafusion/execution/src/config.rs#L197-L207
   
   However, some config options try to explain it again in the setter/getter:
   
https://github.com/apache/datafusion/blob/35c56b020e190126f45395a217d47475f5f6f020/datafusion/execution/src/config.rs#L301
   
   It would be better to keep the setter/getter comments consistent: simply 
point to the definition.
   
   ### Describe the solution you'd like
   
   _No response_
   
   ### Describe alternatives you've considered
   
   _No response_
   
   ### Additional context
   
   _No response_


-- 
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