From 2ede5a0a1535b343cec088b07cb8cfe79a0e8b8a Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Wed, 30 Sep 2020 15:37:00 +0200 Subject: [PATCH] Add missing_docs lint to the rustdoc lint group --- compiler/rustc_lint/src/lib.rs | 1 + src/test/rustdoc-ui/lint-group.rs | 4 ++++ src/test/rustdoc-ui/lint-group.stderr | 21 ++++++++++++++++++++- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/compiler/rustc_lint/src/lib.rs b/compiler/rustc_lint/src/lib.rs index 7f7472d9283b8..1b8d6cfb10838 100644 --- a/compiler/rustc_lint/src/lib.rs +++ b/compiler/rustc_lint/src/lib.rs @@ -306,6 +306,7 @@ fn register_builtins(store: &mut LintStore, no_interleave_lints: bool) { "rustdoc", BROKEN_INTRA_DOC_LINKS, INVALID_CODEBLOCK_ATTRIBUTES, + MISSING_DOCS, MISSING_DOC_CODE_EXAMPLES, PRIVATE_DOC_TESTS ); diff --git a/src/test/rustdoc-ui/lint-group.rs b/src/test/rustdoc-ui/lint-group.rs index e58c8b12f68cb..59dec855d08a1 100644 --- a/src/test/rustdoc-ui/lint-group.rs +++ b/src/test/rustdoc-ui/lint-group.rs @@ -22,3 +22,7 @@ pub fn no_doctest() {} //~^ ERROR missing code example in this documentation /// println!("sup"); /// ``` fn private_doctest() {} //~^^^^^ ERROR documentation test in private item + +pub fn no_doc() {} +//~^ ERROR missing documentation for a function +//~^^ ERROR missing code example in this documentation diff --git a/src/test/rustdoc-ui/lint-group.stderr b/src/test/rustdoc-ui/lint-group.stderr index 4e9134ea469bd..bd0bdd4476985 100644 --- a/src/test/rustdoc-ui/lint-group.stderr +++ b/src/test/rustdoc-ui/lint-group.stderr @@ -1,3 +1,16 @@ +error: missing documentation for a function + --> $DIR/lint-group.rs:26:1 + | +LL | pub fn no_doc() {} + | ^^^^^^^^^^^^^^^ + | +note: the lint level is defined here + --> $DIR/lint-group.rs:7:9 + | +LL | #![deny(rustdoc)] + | ^^^^^^^ + = note: `#[deny(missing_docs)]` implied by `#[deny(rustdoc)]` + error: missing code example in this documentation --> $DIR/lint-group.rs:16:1 | @@ -28,6 +41,12 @@ LL | #![deny(rustdoc)] | ^^^^^^^ = note: `#[deny(private_doc_tests)]` implied by `#[deny(rustdoc)]` +error: missing code example in this documentation + --> $DIR/lint-group.rs:26:1 + | +LL | pub fn no_doc() {} + | ^^^^^^^^^^^^^^^^^^ + error: unresolved link to `error` --> $DIR/lint-group.rs:9:29 | @@ -42,5 +61,5 @@ LL | #![deny(rustdoc)] = note: `#[deny(broken_intra_doc_links)]` implied by `#[deny(rustdoc)]` = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` -error: aborting due to 3 previous errors +error: aborting due to 5 previous errors