-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Add lint when no doc is present at the crate-level #66938
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
Merged
bors
merged 6 commits into
rust-lang:master
from
GuillaumeGomez:lint-for-no-crate-level-doc
Mar 28, 2020
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
12607ef
Add lint when no doc is present at the crate-level
GuillaumeGomez f767f54
rename NO_CRATE_LEVEL_DOC lint into MISSING_CRATE_LEVEL_DOC
GuillaumeGomez a8b0e40
Improve code readability
GuillaumeGomez ffe1289
Update tests
GuillaumeGomez 9664002
Update to new diagnostic
GuillaumeGomez be97eb4
Update lint name to follow convention
GuillaumeGomez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update tests
- Loading branch information
commit ffe1289fd249d31cd98b2da168281ba860330987
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
#![deny(no_crate_level_doc)] | ||
#![deny(missing_crate_level_doc)] | ||
|
||
pub fn foo() {} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,12 @@ | ||
error: No documentation found on this crate top module. | ||
|
||
Maybe you could be interested into looking at this documentation: | ||
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html | ||
error: no documentation found for this crate's top-level module | ||
| | ||
note: lint level defined here | ||
note: the lint level is defined here | ||
--> $DIR/no-crate-level-doc-lint.rs:1:9 | ||
| | ||
LL | #![deny(no_crate_level_doc)] | ||
| ^^^^^^^^^^^^^^^^^^ | ||
LL | #![deny(missing_crate_level_doc)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ | ||
= help: The following guide may be of use: | ||
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html | ||
|
||
error: aborting due to previous error | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.