cj-zhukov commented on PR #19750: URL: https://github.com/apache/datafusion/pull/19750#issuecomment-3789805998
I replaced the shell-based examples documentation generator with a Rust implementation. What changed: - Replaced `generate_examples_docs.sh` with a Rust binary (`examples-docs`) - Removed `examples.toml` - Documentation is now generated directly from structured doc comments in each example group’s `main.rs` - CI script was updated to call the Rust generator instead of the shell script Design change: - Files lived in `examples/<group>/*.rs` - Metadata (subcommand, description) lived in `examples.toml` - A shell script merged the two Now: - Each example group’s `main.rs` contains the authoritative documentation for that group - The Rust generator parses this information and renders the README directly - There is a single source of truth Personally, I find this approach cleaner and more “Rust-native” than maintaining a complex shell script and a separate TOML file. A follow-up PR could switch this to a dedicated parsing crate (e.g. `nom`) if the parsing rules become more complex or harder to maintain. That said, I’m very open to feedback and alternative designs if there are concerns about this direction. -- 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]
