alamb commented on code in PR #25525: URL: https://github.com/apache/datafusion/pull/25525#discussion_r4056709529
########## ci/scripts/check_config_function_docs.sh: ########## Review Comment: Minor: I suggest calling this `check_generated_docs.sh` as it is both shorter and more general ########## docs/source/contributor-guide/testing.md: ########## @@ -304,6 +304,23 @@ the README: ./ci/scripts/check_examples_docs.sh --write ``` +## Config and Function Docs Check + +`docs/source/user-guide/configs.md` and the three function pages under Review Comment: Can we also please make file references github url links so it is easier to follow what is going on? ALso I think a bunch of details of the implementation are irrelevant for people running this check (e.g. that needs cargo and npx ,etc) is irrelevant here -- we could just say somehting like > To check they are up to date, run the `ci/scripts/check_config_function_docs.sh` script, which is also run as part of `./dev/rust_lint.sh` -- 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]
