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 section is not 100% accurate #117

Open
GitGab19 opened this issue Dec 17, 2024 · 1 comment · May be fixed by #118
Open

Framing section is not 100% accurate #117

GitGab19 opened this issue Dec 17, 2024 · 1 comment · May be fixed by #118
Labels
documentation Improvements or additions to documentation

Comments

@GitGab19
Copy link
Collaborator

GitGab19 commented Dec 17, 2024 •
edited
Loading

While reviewing the framing_sv2 docs PR, I noticed that in the Framing chapter we are describing the msg_type field as "Unique identifier of the extension describing this protocol message".

This is not the correct description for sure, we need to fix it.

Also, I think that some concepts there are too much mixed, and hard to grasp.
@GitGab19 GitGab19 added the documentation Improvements or additions to documentation label Dec 17, 2024
@plebhash
Copy link
Contributor

plebhash commented Dec 17, 2024 •
edited
Loading

actually the description of extension_type is also bad... it says a bunch of things like "here's how you can repurpose bits from this field" without actually saying what this field is used for

@GitGab19 GitGab19 changed the title msg_type field description is wrong Framing section is not 100% accurate Dec 17, 2024
@plebhash plebhash linked a pull request Dec 17, 2024 that will close this issue
Open
plebhash added a commit to rrybarczyk/stratum that referenced this issue Dec 17, 2024
@plebhash
fix descriptions of msg_type and extension_type on framing_sv2 README..
78957ef 
for more details see stratum-mining/sv2-spec#117
@plebhash plebhash mentioned this issue Dec 17, 2024
Merged
plebhash added a commit to rrybarczyk/stratum that referenced this issue Dec 17, 2024
@plebhash
fix descriptions of msg_type and extension_type on framing_sv2 docs..
0d99fe0 
for more details see stratum-mining/sv2-spec#117
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

clarify framing section plebhash/sv2-spec
2 participants
@GitGab19 @plebhash