user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove unhelpful help message

Browse source
This commit is contained in:
Camelid 2020-10-02 14:47:41 -07:00
parent 87f3f81451
commit 0193a8871c
8 changed files with 21 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/librustdoc/passes/collect_intra_doc_links.rs
View file

@ -1585,13 +1585,14 @@ fn resolution_failure(
} else {
diag.note(&note);
}
diag.help(&format!("did you mean to import `{}`?", unresolved));
// If the link has `::` in it, assume it was meant to be an intra-doc link.
// Otherwise, the `[]` might be unrelated.
// FIXME: don't show this for autolinks (`<>`), `()` style links, or reference links
if !path_str.contains("::") {
diag.help(r#"to escape `[` and `]` characters, add '\' before them like `\[` or `\]`"#);
}
continue;
}

1
src/test/rustdoc-ui/deny-intra-link-resolution-failure.stderr
View file

@ -9,7 +9,6 @@ note: the lint level is defined here
|
LL | #![deny(broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^
= help: did you mean to import `v2`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
error: aborting due to previous error

5
src/test/rustdoc-ui/intra-link-errors.rs
View file

@ -7,27 +7,22 @@
/// [path::to::nonexistent::module]
//~^ ERROR unresolved link
//~| NOTE there is no item named `path` in scope
//~| HELP did you mean to import `path`?
/// [path::to::nonexistent::macro!]
//~^ ERROR unresolved link
//~| NOTE there is no item named `path` in scope
//~| HELP did you mean to import `path`?
/// [type@path::to::nonexistent::type]
//~^ ERROR unresolved link
//~| NOTE there is no item named `path` in scope
//~| HELP did you mean to import `path`?
/// [std::io::not::here]
//~^ ERROR unresolved link
//~| NOTE there is no item named `not` in scope
//~| HELP did you mean to import `not`?
/// [type@std::io::not::here]
//~^ ERROR unresolved link
//~| NOTE there is no item named `not` in scope
//~| HELP did you mean to import `not`?
/// [std::io::Error::x]
//~^ ERROR unresolved link

47
src/test/rustdoc-ui/intra-link-errors.stderr
View file

@ -9,96 +9,87 @@ note: the lint level is defined here
|
LL | #![deny(broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^
= help: did you mean to import `path`?
error: unresolved link to `path::to::nonexistent::macro`
--> $DIR/intra-link-errors.rs:12:6
--> $DIR/intra-link-errors.rs:11:6
|
LL | /// [path::to::nonexistent::macro!]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ there is no item named `path` in scope
|
= help: did you mean to import `path`?
error: unresolved link to `path::to::nonexistent::type`
--> $DIR/intra-link-errors.rs:17:6
--> $DIR/intra-link-errors.rs:15:6
|
LL | /// [type@path::to::nonexistent::type]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ there is no item named `path` in scope
|
= help: did you mean to import `path`?
error: unresolved link to `std::io::not::here`
--> $DIR/intra-link-errors.rs:22:6
--> $DIR/intra-link-errors.rs:19:6
|
LL | /// [std::io::not::here]
| ^^^^^^^^^^^^^^^^^^ there is no item named `not` in scope
|
= help: did you mean to import `not`?
error: unresolved link to `std::io::not::here`
--> $DIR/intra-link-errors.rs:27:6
--> $DIR/intra-link-errors.rs:23:6
|
LL | /// [type@std::io::not::here]
| ^^^^^^^^^^^^^^^^^^^^^^^ there is no item named `not` in scope
|
= help: did you mean to import `not`?
error: unresolved link to `std::io::Error::x`
--> $DIR/intra-link-errors.rs:32:6
--> $DIR/intra-link-errors.rs:27:6
|
LL | /// [std::io::Error::x]
| ^^^^^^^^^^^^^^^^^ the struct `Error` has no field or associated item named `x`
error: unresolved link to `std::io::ErrorKind::x`
--> $DIR/intra-link-errors.rs:36:6
--> $DIR/intra-link-errors.rs:31:6
|
LL | /// [std::io::ErrorKind::x]
| ^^^^^^^^^^^^^^^^^^^^^ the enum `ErrorKind` has no variant or associated item named `x`
error: unresolved link to `f::A`
--> $DIR/intra-link-errors.rs:40:6
--> $DIR/intra-link-errors.rs:35:6
|
LL | /// [f::A]
| ^^^^ `f` is a function, not a module or type, and cannot have associated items
error: unresolved link to `f::A`
--> $DIR/intra-link-errors.rs:44:6
--> $DIR/intra-link-errors.rs:39:6
|
LL | /// [f::A!]
| ^^^^^ `f` is a function, not a module or type, and cannot have associated items
error: unresolved link to `S::A`
--> $DIR/intra-link-errors.rs:48:6
--> $DIR/intra-link-errors.rs:43:6
|
LL | /// [S::A]
| ^^^^ the struct `S` has no field or associated item named `A`
error: unresolved link to `S::fmt`
--> $DIR/intra-link-errors.rs:52:6
--> $DIR/intra-link-errors.rs:47:6
|
LL | /// [S::fmt]
| ^^^^^^ the struct `S` has no field or associated item named `fmt`
error: unresolved link to `E::D`
--> $DIR/intra-link-errors.rs:56:6
--> $DIR/intra-link-errors.rs:51:6
|
LL | /// [E::D]
| ^^^^ the enum `E` has no variant or associated item named `D`
error: unresolved link to `u8::not_found`
--> $DIR/intra-link-errors.rs:60:6
--> $DIR/intra-link-errors.rs:55:6
|
LL | /// [u8::not_found]
| ^^^^^^^^^^^^^ the builtin type `u8` has no associated item named `not_found`
error: unresolved link to `std::primitive::u8::not_found`
--> $DIR/intra-link-errors.rs:64:6
--> $DIR/intra-link-errors.rs:59:6
|
LL | /// [std::primitive::u8::not_found]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the builtin type `u8` has no associated item named `not_found`
error: unresolved link to `Vec::into_iter`
--> $DIR/intra-link-errors.rs:68:6
--> $DIR/intra-link-errors.rs:63:6
|
LL | /// [type@Vec::into_iter]
| ^^^^^^^^^^^^^^^^^^^
@ -107,7 +98,7 @@ LL | /// [type@Vec::into_iter]
| help: to link to the associated function, add parentheses: `Vec::into_iter()`
error: unresolved link to `S`
--> $DIR/intra-link-errors.rs:73:6
--> $DIR/intra-link-errors.rs:68:6
|
LL | /// [S!]
| ^^
@ -116,7 +107,7 @@ LL | /// [S!]
| help: to link to the struct, prefix with `struct@`: `struct@S`
error: unresolved link to `T::g`
--> $DIR/intra-link-errors.rs:91:6
--> $DIR/intra-link-errors.rs:86:6
|
LL | /// [type@T::g]
| ^^^^^^^^^
@ -125,13 +116,13 @@ LL | /// [type@T::g]
| help: to link to the associated function, add parentheses: `T::g()`
error: unresolved link to `T::h`
--> $DIR/intra-link-errors.rs:96:6
--> $DIR/intra-link-errors.rs:91:6
|
LL | /// [T::h!]
| ^^^^^ the trait `T` has no macro named `h`
error: unresolved link to `S::h`
--> $DIR/intra-link-errors.rs:83:6
--> $DIR/intra-link-errors.rs:78:6
|
LL | /// [type@S::h]
| ^^^^^^^^^
@ -140,7 +131,7 @@ LL | /// [type@S::h]
| help: to link to the associated function, add parentheses: `S::h()`
error: unresolved link to `m`
--> $DIR/intra-link-errors.rs:103:6
--> $DIR/intra-link-errors.rs:98:6
|
LL | /// [m()]
| ^^^

1
src/test/rustdoc-ui/intra-link-span-ice-55723.stderr
View file

@ -9,7 +9,6 @@ note: the lint level is defined here
|
LL | #![deny(broken_intra_doc_links)]
| ^^^^^^^^^^^^^^^^^^^^^^
= help: did you mean to import `i`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
error: aborting due to previous error

4
src/test/rustdoc-ui/intra-links-warning-crlf.stderr
View file

@ -5,7 +5,6 @@ LL | /// [error]
| ^^^^^ there is no item named `error` in scope
|
= note: `#[warn(broken_intra_doc_links)]` on by default
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error1`
@ -14,7 +13,6 @@ warning: unresolved link to `error1`
LL | /// docs [error1]
| ^^^^^^ there is no item named `error1` in scope
|
= help: did you mean to import `error1`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error2`
@ -23,7 +21,6 @@ warning: unresolved link to `error2`
LL | /// docs [error2]
| ^^^^^^ there is no item named `error2` in scope
|
= help: did you mean to import `error2`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -32,7 +29,6 @@ warning: unresolved link to `error`
LL | * It also has an [error].
| ^^^^^ there is no item named `error` in scope
|
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: 4 warnings emitted

23
src/test/rustdoc-ui/intra-links-warning.stderr
View file

@ -11,40 +11,30 @@ warning: unresolved link to `Bar::foo`
|
LL | //! Test with [Foo::baz], [Bar::foo], ...
| ^^^^^^^^ there is no item named `Bar` in scope
|
= help: did you mean to import `Bar`?
warning: unresolved link to `Uniooon::X`
--> $DIR/intra-links-warning.rs:6:13
|
LL | //! , [Uniooon::X] and [Qux::Z].
| ^^^^^^^^^^ there is no item named `Uniooon` in scope
|
= help: did you mean to import `Uniooon`?
warning: unresolved link to `Qux::Z`
--> $DIR/intra-links-warning.rs:6:30
|
LL | //! , [Uniooon::X] and [Qux::Z].
| ^^^^^^ there is no item named `Qux` in scope
|
= help: did you mean to import `Qux`?
warning: unresolved link to `Uniooon::X`
--> $DIR/intra-links-warning.rs:10:14
|
LL | //! , [Uniooon::X] and [Qux::Z].
| ^^^^^^^^^^ there is no item named `Uniooon` in scope
|
= help: did you mean to import `Uniooon`?
warning: unresolved link to `Qux::Z`
--> $DIR/intra-links-warning.rs:10:31
|
LL | //! , [Uniooon::X] and [Qux::Z].
| ^^^^^^ there is no item named `Qux` in scope
|
= help: did you mean to import `Qux`?
warning: unresolved link to `Qux:Y`
--> $DIR/intra-links-warning.rs:14:13
@ -52,7 +42,6 @@ warning: unresolved link to `Qux:Y`
LL | /// [Qux:Y]
| ^^^^^ there is no item named `Qux:Y` in scope
|
= help: did you mean to import `Qux:Y`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -61,7 +50,6 @@ warning: unresolved link to `error`
LL | * time to introduce a link [error]*/
| ^^^^^ there is no item named `error` in scope
|
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -70,7 +58,6 @@ warning: unresolved link to `error`
LL | * time to introduce a link [error]
| ^^^^^ there is no item named `error` in scope
|
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -84,7 +71,6 @@ LL | #[doc = "single line [error]"]
single line [error]
^^^^^
= note: there is no item named `error` in scope
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -98,7 +84,6 @@ LL | #[doc = "single line with \"escaping\" [error]"]
single line with "escaping" [error]
^^^^^
= note: there is no item named `error` in scope
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error`
@ -114,7 +99,6 @@ LL | | /// [error]
[error]
^^^^^
= note: there is no item named `error` in scope
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error1`
@ -123,7 +107,6 @@ warning: unresolved link to `error1`
LL | /// docs [error1]
| ^^^^^^ there is no item named `error1` in scope
|
= help: did you mean to import `error1`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `error2`
@ -132,7 +115,6 @@ warning: unresolved link to `error2`
LL | /// docs [error2]
| ^^^^^^ there is no item named `error2` in scope
|
= help: did you mean to import `error2`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `BarA`
@ -141,7 +123,6 @@ warning: unresolved link to `BarA`
LL | /// bar [BarA] bar
| ^^^^ there is no item named `BarA` in scope
|
= help: did you mean to import `BarA`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `BarB`
@ -150,7 +131,6 @@ warning: unresolved link to `BarB`
LL | * bar [BarB] bar
| ^^^^ there is no item named `BarB` in scope
|
= help: did you mean to import `BarB`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `BarC`
@ -159,7 +139,6 @@ warning: unresolved link to `BarC`
LL | bar [BarC] bar
| ^^^^ there is no item named `BarC` in scope
|
= help: did you mean to import `BarC`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `BarD`
@ -173,7 +152,6 @@ LL | #[doc = "Foo\nbar [BarD] bar\nbaz"]
bar [BarD] bar
^^^^
= note: there is no item named `BarD` in scope
= help: did you mean to import `BarD`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
warning: unresolved link to `BarF`
@ -190,7 +168,6 @@ LL | f!("Foo\nbar [BarF] bar\nbaz");
bar [BarF] bar
^^^^
= note: there is no item named `BarF` in scope
= help: did you mean to import `BarF`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
= note: this warning originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)

1
src/test/rustdoc-ui/lint-group.stderr
View file

@ -40,7 +40,6 @@ note: the lint level is defined here
LL | #![deny(rustdoc)]
| ^^^^^^^
= note: `#[deny(broken_intra_doc_links)]` implied by `#[deny(rustdoc)]`
= help: did you mean to import `error`?
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
error: aborting due to 3 previous errors