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 CI run with -Dmissing-docs #62

Open
cbeck88 opened this issue Mar 25, 2023 · 1 comment
Open

should CI run with -Dmissing-docs #62

cbeck88 opened this issue Mar 25, 2023 · 1 comment

Comments

@cbeck88
Copy link
Contributor

cbeck88 commented Mar 25, 2023

Usually I put #![deny(missing_docs)] in all my crate's lib.rs, and I'd like to encourage other people to do this.

It occurs to me that maybe I shouldn't put this in every crate's source code, and just put it in CI instead

@jcape
Copy link
Contributor

jcape commented Mar 27, 2023

I think putting it in both is ideal. CI forces the issue, but every crate should have that deny as well. In the current templates we deny that, unsafe, and missing debug

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

2 participants