summaryrefslogtreecommitdiffstats
path: root/src/tools/clippy/tests/ui/doc
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 18:31:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-30 18:31:44 +0000
commitc23a457e72abe608715ac76f076f47dc42af07a5 (patch)
tree2772049aaf84b5c9d0ed12ec8d86812f7a7904b6 /src/tools/clippy/tests/ui/doc
parentReleasing progress-linux version 1.73.0+dfsg1-1~progress7.99u1. (diff)
downloadrustc-c23a457e72abe608715ac76f076f47dc42af07a5.tar.xz
rustc-c23a457e72abe608715ac76f076f47dc42af07a5.zip
Merging upstream version 1.74.1+dfsg1.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/tools/clippy/tests/ui/doc')
-rw-r--r--src/tools/clippy/tests/ui/doc/doc-fixable.fixed12
-rw-r--r--src/tools/clippy/tests/ui/doc/doc-fixable.rs12
-rw-r--r--src/tools/clippy/tests/ui/doc/doc-fixable.stderr18
-rw-r--r--src/tools/clippy/tests/ui/doc/unbalanced_ticks.rs12
-rw-r--r--src/tools/clippy/tests/ui/doc/unbalanced_ticks.stderr29
5 files changed, 63 insertions, 20 deletions
diff --git a/src/tools/clippy/tests/ui/doc/doc-fixable.fixed b/src/tools/clippy/tests/ui/doc/doc-fixable.fixed
index 14444df4c..47b56960a 100644
--- a/src/tools/clippy/tests/ui/doc/doc-fixable.fixed
+++ b/src/tools/clippy/tests/ui/doc/doc-fixable.fixed
@@ -1,4 +1,4 @@
-//@run-rustfix
+
//! This file tests for the `DOC_MARKDOWN` lint.
#![allow(dead_code, incomplete_features)]
@@ -198,6 +198,16 @@ fn pulldown_cmark_crash() {}
/// [plain text][path::to::item]
fn intra_doc_link() {}
+/// Ignore escaped\_underscores
+///
+/// \\[
+/// \\prod\_{x\\in X} p\_x
+/// \\]
+fn issue_2581() {}
+
+/// Foo \[bar\] \[baz\] \[qux\]. `DocMarkdownLint`
+fn lint_after_escaped_chars() {}
+
// issue #7033 - generic_const_exprs ICE
struct S<T, const N: usize>
where [(); N.checked_next_power_of_two().unwrap()]: {
diff --git a/src/tools/clippy/tests/ui/doc/doc-fixable.rs b/src/tools/clippy/tests/ui/doc/doc-fixable.rs
index 542d33b13..4d9a4eafa 100644
--- a/src/tools/clippy/tests/ui/doc/doc-fixable.rs
+++ b/src/tools/clippy/tests/ui/doc/doc-fixable.rs
@@ -1,4 +1,4 @@
-//@run-rustfix
+
//! This file tests for the `DOC_MARKDOWN` lint.
#![allow(dead_code, incomplete_features)]
@@ -198,6 +198,16 @@ fn pulldown_cmark_crash() {}
/// [plain text][path::to::item]
fn intra_doc_link() {}
+/// Ignore escaped\_underscores
+///
+/// \\[
+/// \\prod\_{x\\in X} p\_x
+/// \\]
+fn issue_2581() {}
+
+/// Foo \[bar\] \[baz\] \[qux\]. DocMarkdownLint
+fn lint_after_escaped_chars() {}
+
// issue #7033 - generic_const_exprs ICE
struct S<T, const N: usize>
where [(); N.checked_next_power_of_two().unwrap()]: {
diff --git a/src/tools/clippy/tests/ui/doc/doc-fixable.stderr b/src/tools/clippy/tests/ui/doc/doc-fixable.stderr
index 94ef43afc..4c9ff41d9 100644
--- a/src/tools/clippy/tests/ui/doc/doc-fixable.stderr
+++ b/src/tools/clippy/tests/ui/doc/doc-fixable.stderr
@@ -5,6 +5,7 @@ LL | /// The foo_bar function does _nothing_. See also foo::bar. (note the dot t
| ^^^^^^^
|
= note: `-D clippy::doc-markdown` implied by `-D warnings`
+ = help: to override `-D warnings` add `#[allow(clippy::doc_markdown)]`
help: try
|
LL | /// The `foo_bar` function does _nothing_. See also foo::bar. (note the dot there)
@@ -24,12 +25,12 @@ LL | /// The foo_bar function does _nothing_. See also `foo::bar`. (note the dot
error: item in documentation is missing backticks
--> $DIR/doc-fixable.rs:10:83
|
-LL | /// Markdown is _weird_. I mean _really weird_. This /_ is ok. So is `_`. But not Foo::some_fun
+LL | /// Markdown is _weird_. I mean _really weird_. This \_ is ok. So is `_`. But not Foo::some_fun
| ^^^^^^^^^^^^^
|
help: try
|
-LL | /// Markdown is _weird_. I mean _really weird_. This /_ is ok. So is `_`. But not `Foo::some_fun`
+LL | /// Markdown is _weird_. I mean _really weird_. This \_ is ok. So is `_`. But not `Foo::some_fun`
| ~~~~~~~~~~~~~~~
error: item in documentation is missing backticks
@@ -307,5 +308,16 @@ help: try
LL | /// An iterator over `mycrate::Collection`'s values.
| ~~~~~~~~~~~~~~~~~~~~~
-error: aborting due to 28 previous errors
+error: item in documentation is missing backticks
+ --> $DIR/doc-fixable.rs:208:34
+ |
+LL | /// Foo \[bar\] \[baz\] \[qux\]. DocMarkdownLint
+ | ^^^^^^^^^^^^^^^
+ |
+help: try
+ |
+LL | /// Foo \[bar\] \[baz\] \[qux\]. `DocMarkdownLint`
+ | ~~~~~~~~~~~~~~~~~
+
+error: aborting due to 29 previous errors
diff --git a/src/tools/clippy/tests/ui/doc/unbalanced_ticks.rs b/src/tools/clippy/tests/ui/doc/unbalanced_ticks.rs
index 8e8324b30..6f7bab720 100644
--- a/src/tools/clippy/tests/ui/doc/unbalanced_ticks.rs
+++ b/src/tools/clippy/tests/ui/doc/unbalanced_ticks.rs
@@ -1,20 +1,24 @@
//! This file tests for the `DOC_MARKDOWN` lint, specifically cases
//! where ticks are unbalanced (see issue #6753).
-
+//@no-rustfix
#![allow(dead_code)]
#![warn(clippy::doc_markdown)]
/// This is a doc comment with `unbalanced_tick marks and several words that
+//~^ ERROR: backticks are unbalanced
/// should be `encompassed_by` tick marks because they `contain_underscores`.
/// Because of the initial `unbalanced_tick` pair, the error message is
/// very `confusing_and_misleading`.
fn main() {}
/// This paragraph has `unbalanced_tick marks and should stop_linting.
+//~^ ERROR: backticks are unbalanced
///
/// This paragraph is fine and should_be linted normally.
+//~^ ERROR: item in documentation is missing backticks
///
/// Double unbalanced backtick from ``here to here` should lint.
+//~^ ERROR: backticks are unbalanced
///
/// Double balanced back ticks ``start end`` is fine.
fn multiple_paragraphs() {}
@@ -28,11 +32,15 @@ fn in_code_block() {}
/// # `Fine`
///
/// ## not_fine
+//~^ ERROR: item in documentation is missing backticks
///
/// ### `unbalanced
+//~^ ERROR: backticks are unbalanced
///
/// - This `item has unbalanced tick marks
+//~^ ERROR: backticks are unbalanced
/// - This item needs backticks_here
+//~^ ERROR: item in documentation is missing backticks
fn other_markdown() {}
#[rustfmt::skip]
@@ -40,4 +48,4 @@ fn other_markdown() {}
/// /// `lol`
/// pub struct Struct;
/// ```
-fn iss_7421() {}
+fn issue_7421() {}
diff --git a/src/tools/clippy/tests/ui/doc/unbalanced_ticks.stderr b/src/tools/clippy/tests/ui/doc/unbalanced_ticks.stderr
index f2ac6bc32..89ad8db39 100644
--- a/src/tools/clippy/tests/ui/doc/unbalanced_ticks.stderr
+++ b/src/tools/clippy/tests/ui/doc/unbalanced_ticks.stderr
@@ -1,7 +1,9 @@
error: backticks are unbalanced
- --> $DIR/unbalanced_ticks.rs:7:1
+ --> $DIR/unbalanced_ticks.rs:7:5
|
-LL | / /// This is a doc comment with `unbalanced_tick marks and several words that
+LL | /// This is a doc comment with `unbalanced_tick marks and several words that
+ | _____^
+LL | |
LL | | /// should be `encompassed_by` tick marks because they `contain_underscores`.
LL | | /// Because of the initial `unbalanced_tick` pair, the error message is
LL | | /// very `confusing_and_misleading`.
@@ -9,17 +11,18 @@ LL | | /// very `confusing_and_misleading`.
|
= help: a backtick may be missing a pair
= note: `-D clippy::doc-markdown` implied by `-D warnings`
+ = help: to override `-D warnings` add `#[allow(clippy::doc_markdown)]`
error: backticks are unbalanced
- --> $DIR/unbalanced_ticks.rs:13:1
+ --> $DIR/unbalanced_ticks.rs:14:5
|
LL | /// This paragraph has `unbalanced_tick marks and should stop_linting.
- | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: a backtick may be missing a pair
error: item in documentation is missing backticks
- --> $DIR/unbalanced_ticks.rs:15:32
+ --> $DIR/unbalanced_ticks.rs:17:32
|
LL | /// This paragraph is fine and should_be linted normally.
| ^^^^^^^^^
@@ -30,15 +33,15 @@ LL | /// This paragraph is fine and `should_be` linted normally.
| ~~~~~~~~~~~
error: backticks are unbalanced
- --> $DIR/unbalanced_ticks.rs:17:1
+ --> $DIR/unbalanced_ticks.rs:20:5
|
LL | /// Double unbalanced backtick from ``here to here` should lint.
- | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: a backtick may be missing a pair
error: item in documentation is missing backticks
- --> $DIR/unbalanced_ticks.rs:30:8
+ --> $DIR/unbalanced_ticks.rs:34:8
|
LL | /// ## not_fine
| ^^^^^^^^
@@ -49,23 +52,23 @@ LL | /// ## `not_fine`
| ~~~~~~~~~~
error: backticks are unbalanced
- --> $DIR/unbalanced_ticks.rs:32:1
+ --> $DIR/unbalanced_ticks.rs:37:5
|
LL | /// ### `unbalanced
- | ^^^^^^^^^^^^^^^^^^^
+ | ^^^^^^^^^^^^^^^
|
= help: a backtick may be missing a pair
error: backticks are unbalanced
- --> $DIR/unbalanced_ticks.rs:34:1
+ --> $DIR/unbalanced_ticks.rs:40:5
|
LL | /// - This `item has unbalanced tick marks
- | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
= help: a backtick may be missing a pair
error: item in documentation is missing backticks
- --> $DIR/unbalanced_ticks.rs:35:23
+ --> $DIR/unbalanced_ticks.rs:42:23
|
LL | /// - This item needs backticks_here
| ^^^^^^^^^^^^^^