tisonkun opened a new pull request, #197: URL: https://github.com/apache/datasketches-rust/pull/197
## Summary - Standardize publicly reachable rustdoc summaries on third-person present tense, using forms such as `Creates`, `Updates`, and `Returns`. - Normalize sentence punctuation, inline-code formatting for identifiers and ranges, and `lg_k` terminology while retaining exact Rust parameter names where needed. - Reorder existing sections as Examples, Errors, and Panics, followed by compatibility notes; no failure-semantics sections were added. - Document these conventions in `CONTRIBUTING.md`. ## Scope This is a documentation-only refactor. It does not change code, public APIs, or runtime behavior. ## Validation - `cargo x check` - `cargo x test` - `cargo x lint` - Rustdoc JSON audit across all features for summary voice, punctuation, terminology, and section order -- 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]
