yihua opened a new pull request, #938:
URL: https://github.com/apache/hudi-rs/pull/938
## Description
closes #934
Documents the user-facing Rust API. The `hudi` crate gets crate-level docs
with runnable examples (create and write, snapshot, time travel, incremental,
DataFusion SQL), and docs.rs now builds it with the `datafusion` feature.
`hudi-core` gets refreshed crate and `table` module docs, and rustdoc on every
public item in `config`, `error`, `expr`, `table`, `write`, and the file group
reader, plus `hudi-datafusion`. Those modules now carry
`#[warn(missing_docs)]`, which clippy's `-D warnings` turns into a CI failure.
Broken intra-doc links elsewhere are fixed so `cargo doc` runs clean with `-D
warnings`; the remaining modules (metadata, timeline, storage, hfile, and file
group internals) are left for follow-ups.
## How are the changes test-covered
- [ ] N/A
- [ ] Automated tests (unit and/or integration tests)
- [x] Manual tests
- [x] Details are described below
Docs only, no code changes. The new examples are doctests and pass with
`cargo test --doc` (with and without `--all-features`); CI does not run
doctests today. `RUSTDOCFLAGS="-D warnings" cargo doc`, both clippy legs, and
`cargo fmt --check` pass.
--
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]
