-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Need Rust docs on protocols::v2::noise-sv2
#1013
Comments
Can I take this up? |
I don't understand if the issue is about the readme.md file (what is showed in crates.io) or code comments (what is showed in the docs.rs) or maybe both, I think that we should make it clear |
it makes sense to write both... I'll edit the issue description to reflect this |
Background
Currently, the
protocols::v2::noise-sv2
logic does not contain any in-line rust documentation, resulting in no documentation on its crates.io site.Problem
When a user navigates to this crate crates.io, there is no useful information for the user. This impedes understanding and adoption.
Solution
Navigate through each crate in
protocols::v2::noise-sv2
and add:docs.rs
README.md
file to be displayed incrates.io
While this work is being performed, specific code debt should be looked for and recorded to turn into future issues
The text was updated successfully, but these errors were encountered: