API docs#52
Merged
Merged
Conversation
Contributor
Autoparallel
left a comment
Autoparallel
left a comment
There was a problem hiding this comment.
Looking great!
My suggestions would be to make sure you add module level documentation everywhere.
There's some clippy attributes you can use to check that you have docs everywhere like: #![warn(missing_docs)] and another for docs in private impls too.
| //! 3. K ← KDF(σ): Final static derived key | ||
| //! 4. βᵢ ← Update(Fᵢ, K, βᵢ): Optional state update (counters, hardening) | ||
| //! | ||
| //! ```text |
Contributor
There was a problem hiding this comment.
mermaid could be good
Collaborator
Author
There was a problem hiding this comment.
does cargo doc render them?
Contributor
|
Oh, also, I'd consider building the docs and clicking around to see if it all looks right to you. That usually helps me. |
Autoparallel
approved these changes
Nov 22, 2025
Contributor
Autoparallel
left a comment
Autoparallel
left a comment
There was a problem hiding this comment.
Amazing work @lonerapier !!
Merged
Collaborator
Author
|
all checks passed, merging it! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds initial API docs for modules and other primtives.