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.

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

Should the specification live in parity_scale_codec docs? #4

Open
jsdw opened this issue Sep 22, 2023 · 0 comments
Open

Should the specification live in parity_scale_codec docs? #4

jsdw opened this issue Sep 22, 2023 · 0 comments

Comments

@jsdw
Copy link

jsdw commented Sep 22, 2023

Just a thought; I feel like it would be good to have a form of the specification actually as part of the rust docs for the parity_scale_codec crate. Aside from keeping the docs coupled with the code implementing it, it would allow us to have doc tests to actually verify that all of the examples of encoding and decoding the various types are correct. I'd personally be quite happy to work on this if it was desirable.

Then, this page could focus more on the use cases and "higher level" things which involve making use of the specified bejaviour in various placea and whatever.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant