Skip to content
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::codec-sv2 #1012

Closed
rrybarczyk opened this issue Jun 26, 2024 · 0 comments · Fixed by #1040
Closed

Need Rust docs on protocols::v2::codec-sv2 #1012

rrybarczyk opened this issue Jun 26, 2024 · 0 comments · Fixed by #1040
Assignees
Labels
codec-sv2 documentation Improvements or additions to documentation protocols Lowest level protocol logic
Milestone

Comments

@rrybarczyk
Copy link
Collaborator

rrybarczyk commented Jun 26, 2024

Background

Currently, the protocols::v2::codec-sv2 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::sv2-ffi 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

@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation protocols Lowest level protocol logic codec-sv2 labels Jun 26, 2024
@rrybarczyk rrybarczyk self-assigned this Jun 26, 2024
@rrybarczyk rrybarczyk linked a pull request Jul 5, 2024 that will close this issue
@plebhash plebhash added this to the 1.1.0 milestone Aug 20, 2024
@plebhash plebhash moved this from Todo 📝 to In Progress 🏗️ in SV2 Roadmap 🛣️ Aug 20, 2024
@GitGab19 GitGab19 moved this from In Progress 🏗️ to Ready For Review 🔍 in SV2 Roadmap 🛣️ Oct 11, 2024
@github-project-automation github-project-automation bot moved this from Ready For Review 🔍 to Done ✅ in SV2 Roadmap 🛣️ Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codec-sv2 documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants