tisonkun commented on code in PR #197: URL: https://github.com/apache/datasketches-rust/pull/197#discussion_r3754984189
########## CONTRIBUTING.md: ########## @@ -60,6 +60,13 @@ Lint: cargo x lint ``` +## Public API documentation + +- Describe types with noun phrases and API behavior with third-person present-tense verbs such as `Creates`, `Updates`, and `Returns`. +- End summary sentences with punctuation, and format Rust identifiers, literals, and numeric ranges as inline code. +- Use `lg_k` for the algorithm parameter in prose. Use a different name only when referring to an exact Rust identifier or an external serialization format. +- When applicable, order sections as `# Examples`, `# Errors`, and `# Panics`, followed by compatibility notes. Include only sections that describe an actual contract. Review Comment: I think `Examples` should go in the last position; that is, the contract first, then examles. -- 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]
