Inverse missing_docs logic
#11676
Merged
Inverse missing_docs logic
#11676
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Kanabenki
added
C-Docs
alice-i-cecile
approved these changes
Feb 3, 2024
matiqo15
approved these changes
Feb 3, 2024
matiqo15
added
the
S-Ready-For-Final-Review
mockersf
reviewed
Feb 3, 2024
…bevy into inverse_missing_docs
mockersf
approved these changes
Feb 3, 2024
tjamaan
pushed a commit
to tjamaan/bevy
that referenced
this pull request
Feb 6, 2024
# Objective Currently the `missing_docs` lint is allowed-by-default and enabled at crate level when their documentations is complete (see bevyengine#3492). This PR proposes to inverse this logic by making `missing_docs` warn-by-default and mark crates with imcomplete docs allowed. ## Solution Makes `missing_docs` warn at workspace level and allowed at crate level when the docs is imcomplete.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
Currently the
missing_docslint is allowed-by-default and enabled at crate level when their documentations is complete (see #3492).This PR proposes to inverse this logic by making
missing_docswarn-by-default and mark crates with imcomplete docs allowed.Solution
Makes
missing_docswarn at workspace level and allowed at crate level when the docs is imcomplete.