From 687de4c07c0b533e70646cfe94a9d270eace87e7 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sun, 13 Sep 2020 15:17:00 +0200 Subject: [PATCH 1/2] Don't emit warning on module documentation missing examples --- src/librustdoc/passes/doc_test_lints.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/librustdoc/passes/doc_test_lints.rs b/src/librustdoc/passes/doc_test_lints.rs index cbbe86dc433f3..1384de1c3f2a7 100644 --- a/src/librustdoc/passes/doc_test_lints.rs +++ b/src/librustdoc/passes/doc_test_lints.rs @@ -73,6 +73,7 @@ pub fn should_have_doc_example(item_kind: &clean::ItemEnum) -> bool { | clean::ImportItem(_) | clean::PrimitiveItem(_) | clean::KeywordItem(_) + | clean::ModuleItem(_) ) } From 7e372e4ec9afa1437a90d5b86cdb1f722757cdb7 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Sun, 13 Sep 2020 15:17:07 +0200 Subject: [PATCH 2/2] Update tests --- .../coverage/doc-examples-json.stdout | 2 +- .../rustdoc-ui/coverage/doc-examples.stdout | 4 +-- src/test/rustdoc-ui/coverage/json.stdout | 2 +- src/test/rustdoc-ui/doc-without-codeblock.rs | 3 +- .../rustdoc-ui/doc-without-codeblock.stderr | 28 ++++--------------- .../lint-missing-doc-code-example.rs | 6 ++-- .../lint-missing-doc-code-example.stderr | 9 +----- 7 files changed, 14 insertions(+), 40 deletions(-) diff --git a/src/test/rustdoc-ui/coverage/doc-examples-json.stdout b/src/test/rustdoc-ui/coverage/doc-examples-json.stdout index 92f58556975ae..070fed0783e76 100644 --- a/src/test/rustdoc-ui/coverage/doc-examples-json.stdout +++ b/src/test/rustdoc-ui/coverage/doc-examples-json.stdout @@ -1 +1 @@ -{"$DIR/doc-examples-json.rs":{"total":3,"with_docs":2,"total_examples":2,"with_examples":1}} +{"$DIR/doc-examples-json.rs":{"total":3,"with_docs":2,"total_examples":1,"with_examples":1}} diff --git a/src/test/rustdoc-ui/coverage/doc-examples.stdout b/src/test/rustdoc-ui/coverage/doc-examples.stdout index 10ed13c9ff566..beefe446c8da0 100644 --- a/src/test/rustdoc-ui/coverage/doc-examples.stdout +++ b/src/test/rustdoc-ui/coverage/doc-examples.stdout @@ -1,7 +1,7 @@ +-------------------------------------+------------+------------+------------+------------+ | File | Documented | Percentage | Examples | Percentage | +-------------------------------------+------------+------------+------------+------------+ -| ...tdoc-ui/coverage/doc-examples.rs | 4 | 100.0% | 2 | 50.0% | +| ...tdoc-ui/coverage/doc-examples.rs | 4 | 100.0% | 2 | 66.7% | +-------------------------------------+------------+------------+------------+------------+ -| Total | 4 | 100.0% | 2 | 50.0% | +| Total | 4 | 100.0% | 2 | 66.7% | +-------------------------------------+------------+------------+------------+------------+ diff --git a/src/test/rustdoc-ui/coverage/json.stdout b/src/test/rustdoc-ui/coverage/json.stdout index c2be73ce3edd7..25fd896baf1d3 100644 --- a/src/test/rustdoc-ui/coverage/json.stdout +++ b/src/test/rustdoc-ui/coverage/json.stdout @@ -1 +1 @@ -{"$DIR/json.rs":{"total":17,"with_docs":12,"total_examples":15,"with_examples":6}} +{"$DIR/json.rs":{"total":17,"with_docs":12,"total_examples":13,"with_examples":6}} diff --git a/src/test/rustdoc-ui/doc-without-codeblock.rs b/src/test/rustdoc-ui/doc-without-codeblock.rs index 5ad8e8a826f05..3cc22e775682b 100644 --- a/src/test/rustdoc-ui/doc-without-codeblock.rs +++ b/src/test/rustdoc-ui/doc-without-codeblock.rs @@ -1,11 +1,10 @@ -#![deny(missing_doc_code_examples)] //~ ERROR missing code example in this documentation +#![deny(missing_doc_code_examples)] /// Some docs. //~^ ERROR missing code example in this documentation pub struct Foo; /// And then, the princess died. -//~^ ERROR missing code example in this documentation pub mod foo { /// Or maybe not because she saved herself! //~^ ERROR missing code example in this documentation diff --git a/src/test/rustdoc-ui/doc-without-codeblock.stderr b/src/test/rustdoc-ui/doc-without-codeblock.stderr index f2b2328322a7b..1436311ff5e94 100644 --- a/src/test/rustdoc-ui/doc-without-codeblock.stderr +++ b/src/test/rustdoc-ui/doc-without-codeblock.stderr @@ -1,14 +1,8 @@ error: missing code example in this documentation - --> $DIR/doc-without-codeblock.rs:1:1 + --> $DIR/doc-without-codeblock.rs:3:1 | -LL | / #![deny(missing_doc_code_examples)] -LL | | -LL | | /// Some docs. -LL | | -... | -LL | | pub fn bar() {} -LL | | } - | |_^ +LL | /// Some docs. + | ^^^^^^^^^^^^^^ | note: the lint level is defined here --> $DIR/doc-without-codeblock.rs:1:9 @@ -17,22 +11,10 @@ LL | #![deny(missing_doc_code_examples)] | ^^^^^^^^^^^^^^^^^^^^^^^^^ error: missing code example in this documentation - --> $DIR/doc-without-codeblock.rs:3:1 - | -LL | /// Some docs. - | ^^^^^^^^^^^^^^ - -error: missing code example in this documentation - --> $DIR/doc-without-codeblock.rs:7:1 - | -LL | /// And then, the princess died. - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -error: missing code example in this documentation - --> $DIR/doc-without-codeblock.rs:10:5 + --> $DIR/doc-without-codeblock.rs:9:5 | LL | /// Or maybe not because she saved herself! | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -error: aborting due to 4 previous errors +error: aborting due to 2 previous errors diff --git a/src/test/rustdoc-ui/lint-missing-doc-code-example.rs b/src/test/rustdoc-ui/lint-missing-doc-code-example.rs index ebe7a242211bf..03cffc6bd3bdd 100644 --- a/src/test/rustdoc-ui/lint-missing-doc-code-example.rs +++ b/src/test/rustdoc-ui/lint-missing-doc-code-example.rs @@ -16,13 +16,13 @@ fn test() { } #[allow(missing_docs)] -mod module1 { //~ ERROR +mod module1 { } -#[allow(missing_doc_code_examples)] -/// doc +/// doc (no code example and it's fine!) mod module2 { + #[allow(missing_doc_code_examples)] /// doc pub fn test() {} } diff --git a/src/test/rustdoc-ui/lint-missing-doc-code-example.stderr b/src/test/rustdoc-ui/lint-missing-doc-code-example.stderr index 32756c99e7f9f..615721f1ca881 100644 --- a/src/test/rustdoc-ui/lint-missing-doc-code-example.stderr +++ b/src/test/rustdoc-ui/lint-missing-doc-code-example.stderr @@ -22,18 +22,11 @@ error: missing code example in this documentation LL | /// Doc | ^^^^^^^ -error: missing code example in this documentation - --> $DIR/lint-missing-doc-code-example.rs:19:1 - | -LL | / mod module1 { -LL | | } - | |_^ - error: missing code example in this documentation --> $DIR/lint-missing-doc-code-example.rs:37:3 | LL | /// doc | ^^^^^^^ -error: aborting due to 5 previous errors +error: aborting due to 4 previous errors