Currently, the protocols::v2::binary_sv2::no-serde-sv2::codec logic does not contain any in-line rust documentation, resulting in no documentation on its crates.io site.
Note: While this issue addresses the need for doc comments, it will also serve as a means to identify code debt that needs to be cleaned up and addressed in future issues.
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::binary_codec_sv2 and add:
Rust Docs comments (following the formatting structure in this on-going discussion), to be displayed in docs.rs
a descriptive README.md file to be displayed in crates.io
While this work is being performed, specific code debt should be looked for and recorded to turn into future issues
Shourya742
commented
1 month ago
Background
Currently, the
protocols::v2::binary_sv2::no-serde-sv2::codeclogic 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::binary_codec_sv2and add:docs.rsREADME.mdfile to be displayed incrates.ioWhile this work is being performed, specific code debt should be looked for and recorded to turn into future issues