8000 Add lint when no doc is present at the crate-level by GuillaumeGomez · Pull Request #66938 · rust-lang/rust · GitHub
[go: up one dir, main page]

Skip to content

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
merged 6 commits into from
Mar 28, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update tests
  • Loading branch information
GuillaumeGomez committed Mar 22, 2020
commit ffe1289fd249d31cd98b2da168281ba860330987
2 changes: 1 addition & 1 deletion src/test/rustdoc-ui/no-crate-level-doc-lint.rs
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() {}
13 changes: 6 additions & 7 deletions src/test/rustdoc-ui/no-crate-level-doc-lint.stderr
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

0