andygrove opened a new pull request, #58: URL: https://github.com/apache/datafusion-spark/pull/58
Part of #55 **Depends on #57.** This branch is stacked on it, so until #57 merges the diff also shows its commit. Only the last commit is new here. ## Rationale Per-function docs are almost entirely missing (only 1 of 87 UDFs implements `documentation()`). Before filling them in across the crate, this agrees on a template and shows two complete examples. ## Changes - Add a "Documentation Guidelines" section to `crates/spark/README.md` with a template for the struct rustdoc and for `documentation()`. - Add reference docs for `sha2` and `substring`, covering Spark-specific behavior, arguments and examples. Everything documented is covered by the existing SLT tests or visible in the code. - Use `Documentation::builder` with a `LazyLock` static, so no `datafusion-macros` dependency is needed. ## Testing There is no workspace root in my checkout, so I checked the two files by swapping them into a copy of the published 55.2.0 crate: it compiles, `documentation()` returns the expected content in a throwaway test, and `cargo doc --all-features` with warnings denied is clean. The repo's own test suite was not run. -- 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]
