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

Improve documentation #18

Closed
Nashtare opened this issue Jan 10, 2024 · 0 comments · Fixed by #64
Closed

Improve documentation #18

Nashtare opened this issue Jan 10, 2024 · 0 comments · Fixed by #64
Assignees
Labels
crate: trace_decoder Anything related to the trace_decoder crate. documentation Improvements or additions to documentation

Comments

@Nashtare
Copy link
Collaborator

In the line of #19, it would be beneficial to strengthen the documentation of the codebase, in particular on the protocol-decoder subcrate side, to allow both maintainers and external contributors an easier time when diving into the internals of proof IR generation.

Similarly to what was done in 0xPolygonZero/plonky-block-proof-gen#8, it may be nice to add sufficient meaningful documentation so that we can add

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(missing_docs)]

at the top of the protocol-decoder crate without compilation error.

Probably not of highest priority for now, but adding a tracking ticket nonetheless.

Side note: The attributes above were added as part of 0xPolygonZero/plonky-block-proof-gen#8 but were removed during the merging with this repo. It could be re-enabled for the plonky-block-proof-gen subcrate when dealing with this issue, as the requirements are already satisfied.

@Nashtare Nashtare added the documentation Improvements or additions to documentation label Jan 10, 2024
@Nashtare Nashtare transferred this issue from 0xPolygonZero/proof-protocol-decoder Feb 13, 2024
@Nashtare Nashtare added the crate: trace_decoder Anything related to the trace_decoder crate. label Feb 13, 2024
BGluth added a commit that referenced this issue Feb 16, 2024
@Nashtare Nashtare moved this from Backlog to In Progress in Zero EVM Feb 19, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in Zero EVM Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crate: trace_decoder Anything related to the trace_decoder crate. documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants