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

Warn on missing_docs by default #287

Open
jstarks opened this issue Nov 9, 2024 · 0 comments
Open

Warn on missing_docs by default #287

jstarks opened this issue Nov 9, 2024 · 0 comments
Assignees
Labels
linting Changes for better linting and/or their cleanups

Comments

@jstarks
Copy link
Member

jstarks commented Nov 9, 2024

Right now, crates that want to enforce docs have #![warn(missing_docs)], while crates that do not write nothing. Let's flip this and require the negligent crates to write #![allow(missing_docs)]. This should encourage better behavior for new crates, and make it easy to see which crates are still lacking docs.

@smalis-msft smalis-msft added the linting Changes for better linting and/or their cleanups label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
linting Changes for better linting and/or their cleanups
Projects
None yet
Development

No branches or pull requests

2 participants