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

Rust Docs CI #1270

Closed
plebhash opened this issue Dec 5, 2024 · 0 comments
Closed

Rust Docs CI #1270

plebhash opened this issue Dec 5, 2024 · 0 comments

Comments

@plebhash
Copy link
Collaborator

plebhash commented Dec 5, 2024

as @Shourya742 pointed out, there's a very interesting rustdoc lint macro available: missing_docs

by combining it with the deny filter, we have a powerful filter that if integrated into SRI CI, will make sure we never let any public API go without docs ever again.

this will give us confidence to move forward from #845 knowing that we didn't let anything go without notice

some files already contain this, but we need a PR that adds this macro to every file that still doesn't have it.

#![deny(missing_docs)]

this PR should also add a new CI workflow that enforces running cargo doc --all-features recursively across all crates in the repo

@plebhash plebhash added this to the 1.2.0 milestone Dec 5, 2024
@GitGab19 GitGab19 removed this from the 1.2.0 milestone Dec 9, 2024
@github-project-automation github-project-automation bot moved this from Todo 📝 to Done ✅ in SV2 Roadmap 🛣️ Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants