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

Add #![warn(missing_docs)] crate-level rule #22

Closed
alice-i-cecile opened this issue May 11, 2022 · 2 comments · Fixed by #96
Closed

Add #![warn(missing_docs)] crate-level rule #22

alice-i-cecile opened this issue May 11, 2022 · 2 comments · Fixed by #96
Labels
build system Make continuous integration do the tedious things code quality Make the code cleaner or prettier. documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@alice-i-cecile
Copy link
Collaborator

Docs matter, and this is a great way to verify that we've cleaned up the docs, and don't add new code without docs.

CI is required to pass for code to be merged, and warnings will block CI without being quite as annoying as deny or forbid for local development.

@alice-i-cecile alice-i-cecile added documentation Improvements or additions to documentation code quality Make the code cleaner or prettier. build system Make continuous integration do the tedious things labels May 11, 2022
@CobaltCause
Copy link
Contributor

There's also #[warn(clippy::missing_docs_in_private_items)]. Requiring docs for internal items can make first-few-times contributions easier, although some may consider this lint too annoying to allow it to fail CI, which is understandable.

@alice-i-cecile
Copy link
Collaborator Author

alice-i-cecile commented May 12, 2022

Good call. I'm not opposed to doing so for this sort of crate. Let's see what it looks like; I'm not sure we're likely to have many private items in this style of crate.

EDIT: after poking around the internals more I'm 100% on-board.

@alice-i-cecile alice-i-cecile added the good first issue Good for newcomers label Jun 8, 2022
@alice-i-cecile alice-i-cecile mentioned this issue Jun 8, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build system Make continuous integration do the tedious things code quality Make the code cleaner or prettier. documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants