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

fix broken documentation when running cargo doc --document-private-items #718

Open
0xaatif opened this issue Oct 10, 2024 · 0 comments
Open

fix broken documentation when running cargo doc --document-private-items #718

0xaatif opened this issue Oct 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
x Misc.

Comments

@0xaatif
Copy link
Contributor

0xaatif commented Oct 10, 2024 •
edited
Loading

zk_evm/.github/workflows/lint.yml

Lines 44 to 51 in adeaa4e

# TODO(zero): https://github.com/0xPolygonZero/zk_evm/issues/718
- run: >
RUSTDOCFLAGS='-D warnings -A rustdoc::private_intra_doc_links' cargo doc --no-deps --document-private-items
--package trace_decoder
--package compat
--package smt_trie
--package zk_evm_proc_macro
--package zk_evm_common

this should apply to all packages, not just the whitelisted ones
@github-project-automation github-project-automation bot moved this to Backlog in Zero EVM Oct 10, 2024
@0xaatif 0xaatif mentioned this issue Oct 11, 2024
Merged
@0xaatif 0xaatif changed the title fix private docs fix broken documentation when running cargo doc --document-private-items Nov 4, 2024
@0xaatif 0xaatif added the documentation Improvements or additions to documentation label Nov 4, 2024
@0xaatif 0xaatif added this to the x Misc. milestone Nov 4, 2024
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
Zero EVM
Status: Backlog
Milestone
x Misc.
Development

No branches or pull requests
1 participant
@0xaatif