Skip to content

docs: standardize public API documentation style - #197

Merged
tisonkun merged 2 commits into
mainfrom
codex/normalize-rustdoc-style
Aug 11, 2026
Merged

docs: standardize public API documentation style#197
tisonkun merged 2 commits into
mainfrom
codex/normalize-rustdoc-style

Conversation

@tisonkun

Copy link
Copy Markdown
Member

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

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
@tisonkun

Copy link
Copy Markdown
Member Author

All reviewed. The documents of HllType can be reverted to contain more details. But the current version focuses more on user-facing information and I think it's fair enough to do the change now until someone has a different opinion.

Merging ...

@tisonkun
tisonkun merged commit 035c977 into main Aug 11, 2026
10 checks passed
@tisonkun
tisonkun deleted the codex/normalize-rustdoc-style branch August 11, 2026 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant