alamb commented on code in PR #17039:
URL: https://github.com/apache/datafusion/pull/17039#discussion_r2252340052
##########
datafusion/common/src/config.rs:
##########
@@ -1008,11 +1008,23 @@ impl ConfigOptions {
e.0.set(key, value)
}
- /// Create new ConfigOptions struct, taking values from
- /// environment variables where possible.
+ /// Create new [`ConfigOptions`], taking values from environment variables
+ /// where possible.
///
- /// For example, setting `DATAFUSION_EXECUTION_BATCH_SIZE` will
- /// control `datafusion.execution.batch_size`.
+ /// For example, to configure `datafusion.execution.batch_size`
Review Comment:
This information was previously in the user guide but it feels like code
level details so I moved it
##########
dev/update_config_docs.sh:
##########
@@ -50,22 +50,49 @@ cat <<'EOF' > "$TARGET_FILE"
-->
<!---
-This file was generated by the dev/update_config_docs.sh script.
+NOTE: This file was generated by the dev/update_config_docs.sh script.
Do not edit it manually as changes will be overwritten.
Instead, edit dev/update_config_docs.sh or the docstrings in
datafusion/core/src/config.rs.
-->
# Configuration Settings
-The following configuration options can be passed to `SessionConfig` to
control various aspects of query execution.
+DataFusion configurations control various aspects of DataFusion planning and
execution
-For applications which do not expose `SessionConfig`, like `datafusion-cli`,
these options may also be set via environment variables.
Review Comment:
this content is moved into ConfigOptions docs
--
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: github-unsubscr...@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org
For additional commands, e-mail: github-h...@datafusion.apache.org
