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

Follow-up octet-stream codec - short explanation #1194

Closed
danielpeintner opened this issue Dec 15, 2023 · 2 comments · Fixed by #1209
Closed

Follow-up octet-stream codec - short explanation #1194

danielpeintner opened this issue Dec 15, 2023 · 2 comments · Fixed by #1209
Labels
core Issues with the core library documentation

Comments

@danielpeintner
Copy link
Member

danielpeintner commented Dec 15, 2023 •
edited
Loading

Thank you very, much for your efforts! We can merge it and try to play with it. As a follow-up work, we should provide a short explanation about the new terms introduced.

Originally posted by @relu91 in #1125 (review)
@danielpeintner danielpeintner added core Issues with the core library documentation labels Dec 15, 2023
@danielpeintner danielpeintner mentioned this issue Dec 15, 2023
Merged
@derwehr
Copy link
Contributor

derwehr commented Dec 21, 2023

I can write up explanations for the added terms along with examples. Where would be the correct place to add the descriptions?

@danielpeintner
Copy link
Member Author

I can write up explanations for the added terms along with examples. Where would be the correct place to add the descriptions?

We have READMEs for each package. Hence I suggest to enhance the core README with a subsection of "Codecs" in which you can explain the octet-stream codec.

@relu91 @JKRhb I hope this is fine by you as well... otherwise we can move around the description

@derwehr derwehr mentioned this issue Jan 2, 2024
Merged
@JKRhb JKRhb linked a pull request Jan 7, 2024 that will close this issue
Follow-up octet-stream codec - short explanation #1194 #1209
Merged
danielpeintner added a commit that referenced this issue Jan 8, 2024
@derwehr @danielpeintner
Follow-up octet-stream codec - short explanation #1194 (#1209)
5dc47c4 
* docs: add `octet-stream` codec documentation

* fix: statisfy prettier

* fix: adjust bit offset

Co-authored-by: danielpeintner <[email protected]>

---------

Co-authored-by: danielpeintner <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
core Issues with the core library documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Follow-up octet-stream codec - short explanation #1194 derwehr/node-wot
2 participants
@derwehr @danielpeintner