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 for utils::buffer #1184

Open
rrybarczyk opened this issue Oct 3, 2024 · 1 comment · May be fixed by #1232
Open

Need Rust docs for utils::buffer #1184

rrybarczyk opened this issue Oct 3, 2024 · 1 comment · May be fixed by #1232
Assignees
@rrybarczyk
Labels
documentation Improvements or additions to documentation util Common utilities/helpers
Milestone
1.2.0

Comments

@rrybarczyk
Copy link
Collaborator

While doing the #1160 issue documenting the codec-sv2 crate and realized there are several core primitives that are dependent on primitives in the utils::buffer. This crate should be properly documented.

Unrelated to this issue, we may want to consider in the future bringing utils::buffer into the protocols/ directory.
@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation util Common utilities/helpers labels Oct 3, 2024
@rrybarczyk rrybarczyk self-assigned this Oct 3, 2024
@plebhash plebhash mentioned this issue Oct 3, 2024
Open
78 tasks
@plebhash plebhash added this to the 1.2.0 milestone Oct 3, 2024
@plebhash
Copy link
Collaborator

plebhash commented Oct 3, 2024

#1009 is also closely related to this

@GitGab19 GitGab19 changed the title Rust docs for utils::buffer Need Rust docs for utils::buffer Oct 11, 2024
@rrybarczyk rrybarczyk linked a pull request Oct 21, 2024 that will close this issue
Open
@rrybarczyk rrybarczyk linked a pull request Oct 21, 2024 that will close this issue
Utils buffer sv2 docs #1232
Open
@rrybarczyk rrybarczyk moved this from Todo 📝 to In Progress 🏗️ in SV2 Roadmap 🛣️ Oct 21, 2024
@GitGab19 GitGab19 moved this from In Progress 🏗️ to Ready For Review 🔍 in SV2 Roadmap 🛣️ Nov 8, 2024
@rrybarczyk rrybarczyk mentioned this issue Nov 13, 2024
Open
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 util Common utilities/helpers
Projects
SV2 Roadmap 🛣️
Status: Ready For Review 🔍
Milestone
1.2.0
Development

Successfully merging a pull request may close this issue.

Utils buffer sv2 docs rrybarczyk/stratum
2 participants
@rrybarczyk @plebhash