Follow guidelines for lint suggestions

rust-lang · Dec 12, 2023 · ef1536e · ef1536e
1 parent 53dcec8
commit ef1536e
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 29 deletions.
diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs
@@ -1289,7 +1289,8 @@ impl LangString {
                             && let Some(extra) = extra
                         {
                             extra.error_invalid_codeblock_attr(format!(
-                                "unknown attribute `{x}`. Did you mean `edition{}`?",
+                                "unknown attribute `{x}`. There is an attribute with a similar \
+                                 name: `edition{}`?",
                                 &x[4..]
                             ));
                         }
@@ -1338,7 +1339,10 @@ impl LangString {
                         } {
                             if let Some(extra) = extra {
                                 extra.error_invalid_codeblock_attr_with_help(
-                                    format!("unknown attribute `{x}`. Did you mean `{flag}`?"),
+                                    format!(
+                                        "unknown attribute `{x}`. There is an attribute with a \
+                                         similar name: `{flag}`?"
+                                    ),
                                     help,
                                 );
                             }

diff --git a/tests/rustdoc-ui/doctest/check-attr-test.stderr b/tests/rustdoc-ui/doctest/check-attr-test.stderr
@@ -1,4 +1,4 @@
-error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
+error: unknown attribute `compile-fail`. There is an attribute with a similar name: `compile_fail`?
  --> $DIR/check-attr-test.rs:5:1
   |
 5 | / /// foo
@@ -15,7 +15,7 @@ note: the lint level is defined here
 3 | #![deny(rustdoc::invalid_codeblock_attributes)]
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-error: unknown attribute `compilefail`. Did you mean `compile_fail`?
+error: unknown attribute `compilefail`. There is an attribute with a similar name: `compile_fail`?
  --> $DIR/check-attr-test.rs:5:1
   |
 5 | / /// foo
@@ -27,7 +27,7 @@ error: unknown attribute `compilefail`. Did you mean `compile_fail`?
   |
   = help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
 
-error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
+error: unknown attribute `comPile_fail`. There is an attribute with a similar name: `compile_fail`?
  --> $DIR/check-attr-test.rs:5:1
   |
 5 | / /// foo
@@ -39,7 +39,7 @@ error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
   |
   = help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
 
-error: unknown attribute `should-panic`. Did you mean `should_panic`?
+error: unknown attribute `should-panic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr-test.rs:12:1
    |
 12 | / /// bar
@@ -51,7 +51,7 @@ error: unknown attribute `should-panic`. Did you mean `should_panic`?
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
+error: unknown attribute `shouldpanic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr-test.rs:12:1
    |
 12 | / /// bar
@@ -63,7 +63,7 @@ error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `shOuld_panic`. Did you mean `should_panic`?
+error: unknown attribute `shOuld_panic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr-test.rs:12:1
    |
 12 | / /// bar
@@ -75,7 +75,7 @@ error: unknown attribute `shOuld_panic`. Did you mean `should_panic`?
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `no-run`. Did you mean `no_run`?
+error: unknown attribute `no-run`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr-test.rs:19:1
    |
 19 | / /// foobar
@@ -87,7 +87,7 @@ error: unknown attribute `no-run`. Did you mean `no_run`?
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `norun`. Did you mean `no_run`?
+error: unknown attribute `norun`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr-test.rs:19:1
    |
 19 | / /// foobar
@@ -99,7 +99,7 @@ error: unknown attribute `norun`. Did you mean `no_run`?
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `nO_run`. Did you mean `no_run`?
+error: unknown attribute `nO_run`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr-test.rs:19:1
    |
 19 | / /// foobar
@@ -111,7 +111,7 @@ error: unknown attribute `nO_run`. Did you mean `no_run`?
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `test-harness`. Did you mean `test_harness`?
+error: unknown attribute `test-harness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr-test.rs:26:1
    |
 26 | / /// b
@@ -123,7 +123,7 @@ error: unknown attribute `test-harness`. Did you mean `test_harness`?
    |
    = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
 
-error: unknown attribute `testharness`. Did you mean `test_harness`?
+error: unknown attribute `testharness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr-test.rs:26:1
    |
 26 | / /// b
@@ -135,7 +135,7 @@ error: unknown attribute `testharness`. Did you mean `test_harness`?
    |
    = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
 
-error: unknown attribute `tesT_harness`. Did you mean `test_harness`?
+error: unknown attribute `tesT_harness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr-test.rs:26:1
    |
 26 | / /// b

diff --git a/tests/rustdoc-ui/lints/check-attr.stderr b/tests/rustdoc-ui/lints/check-attr.stderr
@@ -1,4 +1,4 @@
-error: unknown attribute `compile-fail`. Did you mean `compile_fail`?
+error: unknown attribute `compile-fail`. There is an attribute with a similar name: `compile_fail`?
   --> $DIR/check-attr.rs:3:1
    |
 LL | / /// foo
@@ -17,7 +17,7 @@ note: the lint level is defined here
 LL | #![deny(rustdoc::invalid_codeblock_attributes)]
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-error: unknown attribute `compilefail`. Did you mean `compile_fail`?
+error: unknown attribute `compilefail`. There is an attribute with a similar name: `compile_fail`?
   --> $DIR/check-attr.rs:3:1
    |
 LL | / /// foo
@@ -31,7 +31,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
 
-error: unknown attribute `comPile_fail`. Did you mean `compile_fail`?
+error: unknown attribute `comPile_fail`. There is an attribute with a similar name: `compile_fail`?
   --> $DIR/check-attr.rs:3:1
    |
 LL | / /// foo
@@ -45,7 +45,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it compiles successfully
 
-error: unknown attribute `should-panic`. Did you mean `should_panic`?
+error: unknown attribute `should-panic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr.rs:13:1
    |
 LL | / /// bar
@@ -59,7 +59,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `shouldpanic`. Did you mean `should_panic`?
+error: unknown attribute `shouldpanic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr.rs:13:1
    |
 LL | / /// bar
@@ -73,7 +73,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `sHould_panic`. Did you mean `should_panic`?
+error: unknown attribute `sHould_panic`. There is an attribute with a similar name: `should_panic`?
   --> $DIR/check-attr.rs:13:1
    |
 LL | / /// bar
@@ -87,7 +87,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or won't fail if it doesn't panic when running
 
-error: unknown attribute `no-run`. Did you mean `no_run`?
+error: unknown attribute `no-run`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr.rs:23:1
    |
 LL | / /// foobar
@@ -101,7 +101,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `norun`. Did you mean `no_run`?
+error: unknown attribute `norun`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr.rs:23:1
    |
 LL | / /// foobar
@@ -115,7 +115,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `no_Run`. Did you mean `no_run`?
+error: unknown attribute `no_Run`. There is an attribute with a similar name: `no_run`?
   --> $DIR/check-attr.rs:23:1
    |
 LL | / /// foobar
@@ -129,7 +129,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or will be run (which you might not want)
 
-error: unknown attribute `test-harness`. Did you mean `test_harness`?
+error: unknown attribute `test-harness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr.rs:33:1
    |
 LL | / /// b
@@ -143,7 +143,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
 
-error: unknown attribute `testharness`. Did you mean `test_harness`?
+error: unknown attribute `testharness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr.rs:33:1
    |
 LL | / /// b
@@ -157,7 +157,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
 
-error: unknown attribute `teSt_harness`. Did you mean `test_harness`?
+error: unknown attribute `teSt_harness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-attr.rs:33:1
    |
 LL | / /// b
@@ -171,7 +171,7 @@ LL | | /// ```
    |
    = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
 
-error: unknown attribute `rust2018`. Did you mean `edition2018`?
+error: unknown attribute `rust2018`. There is an attribute with a similar name: `edition2018`?
   --> $DIR/check-attr.rs:43:1
    |
 LL | / /// b

diff --git a/tests/rustdoc-ui/lints/check-fail.stderr b/tests/rustdoc-ui/lints/check-fail.stderr
@@ -22,7 +22,7 @@ note: the lint level is defined here
 LL | #![deny(rustdoc::missing_doc_code_examples)]
    |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-error: unknown attribute `testharness`. Did you mean `test_harness`?
+error: unknown attribute `testharness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-fail.rs:8:1
    |
 LL | / //! ```rust,testharness
@@ -39,7 +39,7 @@ LL | #![deny(rustdoc::all)]
    |         ^^^^^^^^^^^^
    = note: `#[deny(rustdoc::invalid_codeblock_attributes)]` implied by `#[deny(rustdoc::all)]`
 
-error: unknown attribute `testharness`. Did you mean `test_harness`?
+error: unknown attribute `testharness`. There is an attribute with a similar name: `test_harness`?
   --> $DIR/check-fail.rs:17:1
    |
 LL | / /// hello