about summary refs log tree commit diff
diff options
context:
space:
mode:
authoravitex <theavitex@gmail.com>2021-12-29 00:53:12 +1100
committeravitex <theavitex@gmail.com>2021-12-29 00:55:22 +1100
commit992646b9ebfc6eb6240ffaa2c2eec38f8502f168 (patch)
tree9950714af7c982179f8677152063e986b0671fb4
parentb0a1a4469ae3bcab01c999228e0c1e3e9506b43c (diff)
downloadrust-992646b9ebfc6eb6240ffaa2c2eec38f8502f168.tar.gz
rust-992646b9ebfc6eb6240ffaa2c2eec38f8502f168.zip
Improve rustdoc::private_doc_tests tests
- Ensure standard public items are accepted
- Ensure public items not re-exported from private modules are denied
-rw-r--r--src/test/rustdoc-ui/private-public-item-doc-test.rs11
-rw-r--r--src/test/rustdoc-ui/private-public-item-doc-test.stderr18
-rw-r--r--src/test/rustdoc-ui/public-reexported-item-doc-test.rs6
3 files changed, 33 insertions, 2 deletions
diff --git a/src/test/rustdoc-ui/private-public-item-doc-test.rs b/src/test/rustdoc-ui/private-public-item-doc-test.rs
new file mode 100644
index 00000000000..7cc62b38cc2
--- /dev/null
+++ b/src/test/rustdoc-ui/private-public-item-doc-test.rs
@@ -0,0 +1,11 @@
+#![deny(rustdoc::private_doc_tests)]
+
+mod foo {
+    /// private doc test
+    ///
+    /// ```
+    /// assert!(false);
+    /// ```
+    //~^^^^^ ERROR documentation test in private item
+    pub fn bar() {}
+}
diff --git a/src/test/rustdoc-ui/private-public-item-doc-test.stderr b/src/test/rustdoc-ui/private-public-item-doc-test.stderr
new file mode 100644
index 00000000000..f50dbd1844e
--- /dev/null
+++ b/src/test/rustdoc-ui/private-public-item-doc-test.stderr
@@ -0,0 +1,18 @@
+error: documentation test in private item
+  --> $DIR/private-public-item-doc-test.rs:4:5
+   |
+LL | /     /// private doc test
+LL | |     ///
+LL | |     /// ```
+LL | |     /// assert!(false);
+LL | |     /// ```
+   | |___________^
+   |
+note: the lint level is defined here
+  --> $DIR/private-public-item-doc-test.rs:1:9
+   |
+LL | #![deny(rustdoc::private_doc_tests)]
+   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+error: aborting due to previous error
+
diff --git a/src/test/rustdoc-ui/public-reexported-item-doc-test.rs b/src/test/rustdoc-ui/public-reexported-item-doc-test.rs
index 0398975f137..b86a53305a1 100644
--- a/src/test/rustdoc-ui/public-reexported-item-doc-test.rs
+++ b/src/test/rustdoc-ui/public-reexported-item-doc-test.rs
@@ -2,7 +2,9 @@
 
 #![deny(rustdoc::private_doc_tests)]
 
-mod foo {
+pub fn foo() {}
+
+mod private {
     /// re-exported doc test
     ///
     /// ```
@@ -11,4 +13,4 @@ mod foo {
     pub fn bar() {}
 }
 
-pub use foo::bar;
+pub use private::bar;