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::binary_sv2::binary_sv2 #1008

Open
rrybarczyk opened this issue Jun 26, 2024 · 1 comment · May be fixed by #1231
Open

Need Rust docs on protocols::v2::binary_sv2::binary_sv2 #1008

rrybarczyk opened this issue Jun 26, 2024 · 1 comment · May be fixed by #1231
Assignees
Labels
binary-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::binary_sv2::binary_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::binary_sv2::binary_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

@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation protocols Lowest level protocol logic binary-sv2 labels Jun 26, 2024
@rrybarczyk rrybarczyk self-assigned this Jun 26, 2024
@rrybarczyk rrybarczyk changed the title Rust Docs: protocols::v2::binary_sv2 Rust Docs: protocols::v2::binary_sv2::binary_sv2 Jun 26, 2024
@rrybarczyk rrybarczyk changed the title Rust Docs: protocols::v2::binary_sv2::binary_sv2 Need Rust docs on protocols::v2::binary_sv2::binary_sv2 Jun 26, 2024
@rrybarczyk rrybarczyk removed their assignment Jun 26, 2024
@jbesraa
Copy link
Contributor

jbesraa commented Sep 5, 2024

I would like to work on this one

@GitGab19 GitGab19 added this to the 1.1.0 milestone Sep 5, 2024
@plebhash plebhash modified the milestones: 1.1.0, 1.2.0 Sep 9, 2024
@plebhash plebhash assigned Shourya742 and unassigned jbesraa Oct 15, 2024
@Shourya742 Shourya742 linked a pull request Oct 22, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
binary-sv2 documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
Status: In Progress 🏗️
Development

Successfully merging a pull request may close this issue.

5 participants