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.

Sign up for GitHub

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

Jump to bottom

Need Rust docs on protocols::v2::binary_sv2::serde_sv2 #1011

Closed
rrybarczyk opened this issue Jun 26, 2024 · 1 comment
Closed

Need Rust docs on protocols::v2::binary_sv2::serde_sv2 #1011

rrybarczyk opened this issue Jun 26, 2024 · 1 comment
Assignees
@rrybarczyk
Labels
binary-sv2 documentation Improvements or additions to documentation protocols Lowest level protocol logic

Comments

@rrybarczyk
Copy link
Collaborator

rrybarczyk commented Jun 26, 2024 •
edited by plebhash
Loading

Background

Currently, the protocols::v2::binary_sv2::serde_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 binary-sv2 labels Jun 26, 2024
@rrybarczyk rrybarczyk self-assigned this Jun 26, 2024
@rrybarczyk rrybarczyk changed the title Need Rust docs on protocols::v2::binary_sv2::no-serde-sv2::serde_sv2 Need Rust docs on protocols::v2::binary_sv2::serde_sv2 Jun 26, 2024
@rrybarczyk rrybarczyk mentioned this issue Jun 26, 2024
Open
67 tasks
@rrybarczyk rrybarczyk removed their assignment Jun 26, 2024
marathon-gary added a commit to marathon-gary/stratum that referenced this issue Jul 9, 2024
@marathon-gary
doc: Document Seq064K with specifics from spec
01f4090 
Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

stratum-mining#1011
marathon-gary added a commit to marathon-gary/stratum that referenced this issue Jul 9, 2024
@marathon-gary
doc: Document Seq064K
769e2c3 
Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

Work toward: stratum-mining#1011
@marathon-gary marathon-gary mentioned this issue Jul 9, 2024
Open
marathon-gary added a commit to marathon-gary/stratum that referenced this issue Jul 16, 2024
@marathon-gary
doc: Document Seq064K
a849ccb 
Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

Work toward: stratum-mining#1011
marathon-gary added a commit to marathon-gary/stratum that referenced this issue Jul 16, 2024
@marathon-gary
doc: Document Seq064K
3c0fa5a 
Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

Work toward: stratum-mining#1011
@rrybarczyk rrybarczyk mentioned this issue Aug 21, 2024
Closed
marathon-gary added a commit to marathon-gary/stratum that referenced this issue Sep 4, 2024
@marathon-gary
doc: Document Seq064K
7d3e563 
Takes specific of bytes, types and sizes from the specification.
Lists some use cases for this struct.

Work toward: stratum-mining#1011

fix: cargo fmt for docstrings
@rrybarczyk rrybarczyk self-assigned this Sep 9, 2024
@plebhash
Copy link
Collaborator

#845 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rrybarczyk rrybarczyk

Labels
binary-sv2 documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rrybarczyk @plebhash