about summary refs log tree commit diff
path: root/src/test
diff options
context:
space:
mode:
authorDylan DPC <dylan.dpc@gmail.com>2020-08-22 02:14:44 +0200
committerGitHub <noreply@github.com>2020-08-22 02:14:44 +0200
commit441c835278107b13a95d1e7010c63b65073e29f7 (patch)
tree552c8c5ed0e4a0a77483d5ca183e9aeb5822b588 /src/test
parent6cb98e3114cefd8ecd7aa6d48c29109e3a48fc60 (diff)
parentadeedf52435fe893156f93e2771dc66adf02abc9 (diff)
downloadrust-441c835278107b13a95d1e7010c63b65073e29f7.tar.gz
rust-441c835278107b13a95d1e7010c63b65073e29f7.zip
Rollup merge of #75718 - GuillaumeGomez:coverage-ui-doc-examples-count, r=jyn514
Don't count variants/fields/consts/associated types in doc-coverage doc examples

Fixes #75714.

I think I'll need to update the equivalent lint too. Creating an issue for that!

r? @jyn514
Diffstat (limited to 'src/test')
-rw-r--r--src/test/rustdoc-ui/coverage/basic.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/doc-examples-json.rs13
-rw-r--r--src/test/rustdoc-ui/coverage/doc-examples-json.stdout1
-rw-r--r--src/test/rustdoc-ui/coverage/doc-examples.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/empty.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/enums.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/exotic.stdout16
-rw-r--r--src/test/rustdoc-ui/coverage/json.rs40
-rw-r--r--src/test/rustdoc-ui/coverage/json.stdout2
-rw-r--r--src/test/rustdoc-ui/coverage/private.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/statics-consts.stdout14
-rw-r--r--src/test/rustdoc-ui/coverage/traits.stdout14
12 files changed, 111 insertions, 59 deletions
diff --git a/src/test/rustdoc-ui/coverage/basic.stdout b/src/test/rustdoc-ui/coverage/basic.stdout
index 7e795acc575..3c602b3da4c 100644
--- a/src/test/rustdoc-ui/coverage/basic.stdout
+++ b/src/test/rustdoc-ui/coverage/basic.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...est/rustdoc-ui/coverage/basic.rs |          7 |         14 |      50.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          7 |         14 |      50.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...est/rustdoc-ui/coverage/basic.rs |          7 |      50.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          7 |      50.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/doc-examples-json.rs b/src/test/rustdoc-ui/coverage/doc-examples-json.rs
new file mode 100644
index 00000000000..1da1813790e
--- /dev/null
+++ b/src/test/rustdoc-ui/coverage/doc-examples-json.rs
@@ -0,0 +1,13 @@
+// check-pass
+// compile-flags:-Z unstable-options --output-format json --show-coverage
+
+// This check ensures that only one doc example is counted since they're "optional" on
+// certain items.
+
+/// ```
+/// let x = 12;
+/// ```
+pub const Foo: u32 = 0;
+
+/// doc
+pub const Bar: u32 = 0;
diff --git a/src/test/rustdoc-ui/coverage/doc-examples-json.stdout b/src/test/rustdoc-ui/coverage/doc-examples-json.stdout
new file mode 100644
index 00000000000..92f58556975
--- /dev/null
+++ b/src/test/rustdoc-ui/coverage/doc-examples-json.stdout
@@ -0,0 +1 @@
+{"$DIR/doc-examples-json.rs":{"total":3,"with_docs":2,"total_examples":2,"with_examples":1}}
diff --git a/src/test/rustdoc-ui/coverage/doc-examples.stdout b/src/test/rustdoc-ui/coverage/doc-examples.stdout
index f25cf79a3f3..10ed13c9ff5 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 |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...tdoc-ui/coverage/doc-examples.rs |          4 |          4 |     100.0% |          2 |      50.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          4 |          4 |     100.0% |          2 |      50.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...tdoc-ui/coverage/doc-examples.rs |          4 |     100.0% |          2 |      50.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          4 |     100.0% |          2 |      50.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/empty.stdout b/src/test/rustdoc-ui/coverage/empty.stdout
index 2a6a2231e5b..890a7d56e16 100644
--- a/src/test/rustdoc-ui/coverage/empty.stdout
+++ b/src/test/rustdoc-ui/coverage/empty.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...est/rustdoc-ui/coverage/empty.rs |          0 |          1 |       0.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          0 |          1 |       0.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...est/rustdoc-ui/coverage/empty.rs |          0 |       0.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          0 |       0.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/enums.stdout b/src/test/rustdoc-ui/coverage/enums.stdout
index dd86f61f8d5..64c012c1f66 100644
--- a/src/test/rustdoc-ui/coverage/enums.stdout
+++ b/src/test/rustdoc-ui/coverage/enums.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...est/rustdoc-ui/coverage/enums.rs |          6 |          8 |      75.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          6 |          8 |      75.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...est/rustdoc-ui/coverage/enums.rs |          6 |      75.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          6 |      75.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/exotic.stdout b/src/test/rustdoc-ui/coverage/exotic.stdout
index f920a3abd36..e282ff12843 100644
--- a/src/test/rustdoc-ui/coverage/exotic.stdout
+++ b/src/test/rustdoc-ui/coverage/exotic.stdout
@@ -1,8 +1,8 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...st/rustdoc-ui/coverage/exotic.rs |          1 |          1 |     100.0% |          0 |       0.0% |
-| <anon>                              |          2 |          2 |     100.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          3 |          3 |     100.0% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...st/rustdoc-ui/coverage/exotic.rs |          1 |     100.0% |          0 |       0.0% |
+| <anon>                              |          2 |     100.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          3 |     100.0% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/json.rs b/src/test/rustdoc-ui/coverage/json.rs
index 2bd6a312ab5..a591cd5dba4 100644
--- a/src/test/rustdoc-ui/coverage/json.rs
+++ b/src/test/rustdoc-ui/coverage/json.rs
@@ -12,16 +12,54 @@ pub mod foo {
 pub struct X;
 
 /// Bar
+///
+/// ```
+/// let x = 12;
+/// ```
 pub mod bar {
     /// bar
     pub struct Bar;
     /// X
-    pub enum X { Y }
+    pub enum X {
+        /// ```
+        /// let x = "should be ignored!";
+        /// ```
+        Y
+    }
 }
 
 /// yolo
+///
+/// ```text
+/// should not be counted as a code example!
+/// ```
 pub enum Yolo { X }
 
+impl Yolo {
+    /// ```
+    /// let x = "should be ignored!";
+    /// ```
+    pub const Const: u32 = 0;
+}
+
 pub struct Xo<T: Clone> {
+    /// ```
+    /// let x = "should be ignored!";
+    /// ```
     x: T,
 }
+
+/// ```
+/// let x = "should be ignored!";
+/// ```
+pub static StaticFoo: u32 = 0;
+
+/// ```
+/// let x = "should be ignored!";
+/// ```
+pub const ConstFoo: u32 = 0;
+
+/// ```
+/// let x = "should be ignored!";
+/// ```
+pub type TypeFoo = u32;
diff --git a/src/test/rustdoc-ui/coverage/json.stdout b/src/test/rustdoc-ui/coverage/json.stdout
index 7b5b083e158..c2be73ce3ed 100644
--- a/src/test/rustdoc-ui/coverage/json.stdout
+++ b/src/test/rustdoc-ui/coverage/json.stdout
@@ -1 +1 @@
-{"$DIR/json.rs":{"total":13,"with_docs":7,"with_examples":0}}
+{"$DIR/json.rs":{"total":17,"with_docs":12,"total_examples":15,"with_examples":6}}
diff --git a/src/test/rustdoc-ui/coverage/private.stdout b/src/test/rustdoc-ui/coverage/private.stdout
index bca3d51da59..37a0f5187b5 100644
--- a/src/test/rustdoc-ui/coverage/private.stdout
+++ b/src/test/rustdoc-ui/coverage/private.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...t/rustdoc-ui/coverage/private.rs |          4 |          7 |      57.1% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          4 |          7 |      57.1% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...t/rustdoc-ui/coverage/private.rs |          4 |      57.1% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          4 |      57.1% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/statics-consts.stdout b/src/test/rustdoc-ui/coverage/statics-consts.stdout
index 31b48cc602a..dbea3a3ea23 100644
--- a/src/test/rustdoc-ui/coverage/statics-consts.stdout
+++ b/src/test/rustdoc-ui/coverage/statics-consts.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...oc-ui/coverage/statics-consts.rs |          6 |          7 |      85.7% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          6 |          7 |      85.7% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...oc-ui/coverage/statics-consts.rs |          6 |      85.7% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          6 |      85.7% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
diff --git a/src/test/rustdoc-ui/coverage/traits.stdout b/src/test/rustdoc-ui/coverage/traits.stdout
index ac63b65023d..e04d48b4980 100644
--- a/src/test/rustdoc-ui/coverage/traits.stdout
+++ b/src/test/rustdoc-ui/coverage/traits.stdout
@@ -1,7 +1,7 @@
-+-------------------------------------+------------+------------+------------+------------+------------+
-| File                                | Documented |      Total | Percentage |   Examples | Percentage |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| ...st/rustdoc-ui/coverage/traits.rs |          6 |          7 |      85.7% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
-| Total                               |          6 |          7 |      85.7% |          0 |       0.0% |
-+-------------------------------------+------------+------------+------------+------------+------------+
++-------------------------------------+------------+------------+------------+------------+
+| File                                | Documented | Percentage |   Examples | Percentage |
++-------------------------------------+------------+------------+------------+------------+
+| ...st/rustdoc-ui/coverage/traits.rs |          6 |      85.7% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+
+| Total                               |          6 |      85.7% |          0 |       0.0% |
++-------------------------------------+------------+------------+------------+------------+