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

framing-sv2 doc cmts do not conform to standard #1178

Open
rrybarczyk opened this issue Oct 2, 2024 · 0 comments · May be fixed by #1179
Open

framing-sv2 doc cmts do not conform to standard #1178

rrybarczyk opened this issue Oct 2, 2024 · 0 comments · May be fixed by #1179
Assignees
@rrybarczyk
Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic
Milestone
1.2.0

Comments

@rrybarczyk
Copy link
Collaborator

rrybarczyk commented Oct 2, 2024 •
edited
Loading

As a part of the protocols documentation and refactor effort in #845, Rust doc comments were added to the framing-sv2 crate in #848. However, this was done before the team fully finalized the standardization for the Rust doc comments in discussion #970.

The content of the framing-sv2 documentation post-#845 is sound, only the formatting needs to be updated. A README.md will also be added, following the established standard.
@rrybarczyk rrybarczyk self-assigned this Oct 2, 2024
@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation protocols Lowest level protocol logic labels Oct 2, 2024
This was referenced Oct 2, 2024
Open
Open
@GitGab19 GitGab19 linked a pull request Oct 9, 2024 that will close this issue
framing-sv2 doc cmts to conform to standard #1179
Open
@GitGab19 GitGab19 modified the milestones: 1.2.0, 1.1.0 Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rrybarczyk rrybarczyk

Labels
documentation Improvements or additions to documentation protocols Lowest level protocol logic
Projects
SV2 Roadmap 🛣️
Status: In Progress 🏗️
Milestone
1.2.0
Development

Successfully merging a pull request may close this issue.

framing-sv2 doc cmts to conform to standard rrybarczyk/stratum
2 participants
@rrybarczyk @GitGab19