rustdoc: cleaner errors on disambiguator/namespace mismatches

notriddle · notriddle · commit fa5456776e65 · 2024-10-04T09:45:34.000-07:00
diff --git a/src/librustdoc/passes/collect_intra_doc_links.rs b/src/librustdoc/passes/collect_intra_doc_links.rs
@@ -1996,11 +1996,20 @@ fn resolution_failure(
                             &diag_info,
                         );
 
-                        format!(
-                            "this link resolves to {}, which is not in the {} namespace",
-                            item(res),
-                            expected_ns.descr()
-                        )
+                        if let Some(disambiguator) = disambiguator && !matches!(disambiguator, Disambiguator::Namespace(..)) {
+                            format!(
+                                "this link resolves to {}, which is not {} {}",
+                                item(res),
+                                disambiguator.article(),
+                                disambiguator.descr()
+                            )
+                        } else {
+                            format!(
+                                "this link resolves to {}, which is not in the {} namespace",
+                                item(res),
+                                expected_ns.descr()
+                            )
+                        }
                     }
                 };
                 if let Some(span) = sp {
diff --git a/tests/rustdoc-ui/intra-doc/disambiguator-mismatch.stderr b/tests/rustdoc-ui/intra-doc/disambiguator-mismatch.stderr
@@ -74,7 +74,7 @@ error: unresolved link to `m`
   --> $DIR/disambiguator-mismatch.rs:52:14
    |
 LL | /// Link to [m()]
-   |              ^^^ this link resolves to the macro `m`, which is not in the value namespace
+   |              ^^^ this link resolves to the macro `m`, which is not a function
    |
 help: to link to the macro, add an exclamation mark
    |
@@ -142,7 +142,7 @@ error: unresolved link to `std`
   --> $DIR/disambiguator-mismatch.rs:83:14
    |
 LL | /// Link to [fn@std]
-   |              ^^^^^^ this link resolves to the crate `std`, which is not in the value namespace
+   |              ^^^^^^ this link resolves to the crate `std`, which is not a function
    |
 help: to link to the crate, prefix with `mod@`
    |
@@ -164,7 +164,7 @@ error: unresolved link to `S::A`
   --> $DIR/disambiguator-mismatch.rs:93:14
    |
 LL | /// Link to [field@S::A]
-   |              ^^^^^^^^^^ this link resolves to the variant `A`, which is not in the value namespace
+   |              ^^^^^^^^^^ this link resolves to the variant `A`, which is not a field
    |
 help: to link to the variant, prefix with `variant@`
    |
diff --git a/tests/rustdoc-ui/intra-doc/errors.rs b/tests/rustdoc-ui/intra-doc/errors.rs
@@ -98,7 +98,7 @@ pub trait T {
 /// [m()]
 //~^ ERROR unresolved link
 //~| HELP to link to the macro
-//~| NOTE not in the value namespace
+//~| NOTE not a function
 #[macro_export]
 macro_rules! m {
     () => {};
diff --git a/tests/rustdoc-ui/intra-doc/errors.stderr b/tests/rustdoc-ui/intra-doc/errors.stderr
@@ -104,7 +104,7 @@ error: unresolved link to `S`
   --> $DIR/errors.rs:68:6
    |
 LL | /// [S!]
-   |      ^^ this link resolves to the struct `S`, which is not in the macro namespace
+   |      ^^ this link resolves to the struct `S`, which is not a macro
    |
 help: to link to the struct, prefix with `struct@`
    |
@@ -158,7 +158,7 @@ error: unresolved link to `m`
   --> $DIR/errors.rs:98:6
    |
 LL | /// [m()]
-   |      ^^^ this link resolves to the macro `m`, which is not in the value namespace
+   |      ^^^ this link resolves to the macro `m`, which is not a function
    |
 help: to link to the macro, add an exclamation mark
    |
diff --git a/tests/rustdoc-ui/intra-doc/issue-110495-suffix-with-space.stderr b/tests/rustdoc-ui/intra-doc/issue-110495-suffix-with-space.stderr
@@ -2,7 +2,7 @@ error: unresolved link to `Clone`
   --> $DIR/issue-110495-suffix-with-space.rs:3:6
    |
 LL | //! [Clone ()].
-   |      ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |      ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 note: the lint level is defined here
   --> $DIR/issue-110495-suffix-with-space.rs:2:9
@@ -31,7 +31,7 @@ error: unresolved link to `Clone`
   --> $DIR/issue-110495-suffix-with-space.rs:5:7
    |
 LL | //! [`Clone ()`].
-   |       ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |       ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
diff --git a/tests/rustdoc-ui/intra-doc/weird-syntax.stderr b/tests/rustdoc-ui/intra-doc/weird-syntax.stderr
@@ -40,7 +40,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:27:9
    |
 LL | /// [  `Clone ()`  ]
-   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -52,7 +52,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:30:7
    |
 LL | /// [`Clone ()`  ]
-   |       ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |       ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -64,7 +64,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:33:9
    |
 LL | /// [  `Clone ()`]
-   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -76,7 +76,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:36:9
    |
 LL | /// [```Clone ()```]
-   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -88,7 +88,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:42:13
    |
 LL | /// [  ```  Clone ()  ```  ]
-   |             ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |             ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -122,7 +122,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:74:9
    |
 LL | /// [x][Clone()]
-   |         ^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -134,7 +134,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:77:9
    |
 LL | /// [x][Clone  ()]
-   |         ^^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -176,7 +176,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:97:9
    |
 LL | /// [w](Clone\(\))
-   |         ^^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -188,7 +188,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:103:9
    |
 LL | /// [w](Clone())
-   |         ^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
 help: to link to the trait, prefix with `trait@`
    |
@@ -256,7 +256,7 @@ error: unresolved link to `Clone`
   --> $DIR/weird-syntax.rs:132:9
    |
 LL | /// The [cln][] link here will produce a plain text suggestion
-   |         ^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
+   |         ^^^^^ this link resolves to the trait `Clone`, which is not a function
    |
    = help: to link to the trait, prefix with `trait@`: trait@Clone
 

Original file line number	Diff line number	Diff line change
@@ -74,7 +74,7 @@ error: unresolved link to `m`
`74`	`74`	`--> $DIR/disambiguator-mismatch.rs:52:14`
`75`	`75`	`\|`
`76`	`76`	`LL \| /// Link to [m()]`
`77`		- \| ^^^ this link resolves to the macro `m`, which is not in the value namespace
	`77`	+ \| ^^^ this link resolves to the macro `m`, which is not a function
`78`	`78`	`\|`
`79`	`79`	`help: to link to the macro, add an exclamation mark`
`80`	`80`	`\|`
@@ -142,7 +142,7 @@ error: unresolved link to `std`
`142`	`142`	`--> $DIR/disambiguator-mismatch.rs:83:14`
`143`	`143`	`\|`
`144`	`144`	`LL \| /// Link to [fn@std]`
`145`		- \| ^^^^^^ this link resolves to the crate `std`, which is not in the value namespace
	`145`	+ \| ^^^^^^ this link resolves to the crate `std`, which is not a function
`146`	`146`	`\|`
`147`	`147`	help: to link to the crate, prefix with `mod@`
`148`	`148`	`\|`
@@ -164,7 +164,7 @@ error: unresolved link to `S::A`
`164`	`164`	`--> $DIR/disambiguator-mismatch.rs:93:14`
`165`	`165`	`\|`
`166`	`166`	`LL \| /// Link to [field@S::A]`
`167`		- \| ^^^^^^^^^^ this link resolves to the variant `A`, which is not in the value namespace
	`167`	+ \| ^^^^^^^^^^ this link resolves to the variant `A`, which is not a field
`168`	`168`	`\|`
`169`	`169`	help: to link to the variant, prefix with `variant@`
`170`	`170`	`\|`
Original file line number	Diff line number	Diff line change
@@ -104,7 +104,7 @@ error: unresolved link to `S`
`104`	`104`	`--> $DIR/errors.rs:68:6`
`105`	`105`	`\|`
`106`	`106`	`LL \| /// [S!]`
`107`		- \| ^^ this link resolves to the struct `S`, which is not in the macro namespace
	`107`	+ \| ^^ this link resolves to the struct `S`, which is not a macro
`108`	`108`	`\|`
`109`	`109`	help: to link to the struct, prefix with `struct@`
`110`	`110`	`\|`
@@ -158,7 +158,7 @@ error: unresolved link to `m`
`158`	`158`	`--> $DIR/errors.rs:98:6`
`159`	`159`	`\|`
`160`	`160`	`LL \| /// [m()]`
`161`		- \| ^^^ this link resolves to the macro `m`, which is not in the value namespace
	`161`	+ \| ^^^ this link resolves to the macro `m`, which is not a function
`162`	`162`	`\|`
`163`	`163`	`help: to link to the macro, add an exclamation mark`
`164`	`164`	`\|`
Original file line number	Diff line number	Diff line change
@@ -2,7 +2,7 @@ error: unresolved link to `Clone`
`2`	`2`	`--> $DIR/issue-110495-suffix-with-space.rs:3:6`
`3`	`3`	`\|`
`4`	`4`	`LL \| //! [Clone ()].`
`5`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`5`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`6`	`6`	`\|`
`7`	`7`	`note: the lint level is defined here`
`8`	`8`	`--> $DIR/issue-110495-suffix-with-space.rs:2:9`
@@ -31,7 +31,7 @@ error: unresolved link to `Clone`
`31`	`31`	`--> $DIR/issue-110495-suffix-with-space.rs:5:7`
`32`	`32`	`\|`
`33`	`33`	LL \| //! [`Clone ()`].
`34`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`34`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`35`	`35`	`\|`
`36`	`36`	help: to link to the trait, prefix with `trait@`
`37`	`37`	`\|`
Original file line number	Diff line number	Diff line change
@@ -40,7 +40,7 @@ error: unresolved link to `Clone`
`40`	`40`	`--> $DIR/weird-syntax.rs:27:9`
`41`	`41`	`\|`
`42`	`42`	LL \| /// [ `Clone ()` ]
`43`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`43`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`44`	`44`	`\|`
`45`	`45`	help: to link to the trait, prefix with `trait@`
`46`	`46`	`\|`
@@ -52,7 +52,7 @@ error: unresolved link to `Clone`
`52`	`52`	`--> $DIR/weird-syntax.rs:30:7`
`53`	`53`	`\|`
`54`	`54`	LL \| /// [`Clone ()` ]
`55`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`55`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`56`	`56`	`\|`
`57`	`57`	help: to link to the trait, prefix with `trait@`
`58`	`58`	`\|`
@@ -64,7 +64,7 @@ error: unresolved link to `Clone`
`64`	`64`	`--> $DIR/weird-syntax.rs:33:9`
`65`	`65`	`\|`
`66`	`66`	LL \| /// [ `Clone ()`]
`67`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`67`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`68`	`68`	`\|`
`69`	`69`	help: to link to the trait, prefix with `trait@`
`70`	`70`	`\|`
@@ -76,7 +76,7 @@ error: unresolved link to `Clone`
`76`	`76`	`--> $DIR/weird-syntax.rs:36:9`
`77`	`77`	`\|`
`78`	`78`	LL \| /// [```Clone ()```]
`79`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`79`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`80`	`80`	`\|`
`81`	`81`	help: to link to the trait, prefix with `trait@`
`82`	`82`	`\|`
@@ -88,7 +88,7 @@ error: unresolved link to `Clone`
`88`	`88`	`--> $DIR/weird-syntax.rs:42:13`
`89`	`89`	`\|`
`90`	`90`	LL \| /// [ ``` Clone () ``` ]
`91`		- \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`91`	+ \| ^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`92`	`92`	`\|`
`93`	`93`	help: to link to the trait, prefix with `trait@`
`94`	`94`	`\|`
@@ -122,7 +122,7 @@ error: unresolved link to `Clone`
`122`	`122`	`--> $DIR/weird-syntax.rs:74:9`
`123`	`123`	`\|`
`124`	`124`	`LL \| /// [x][Clone()]`
`125`		- \| ^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`125`	+ \| ^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`126`	`126`	`\|`
`127`	`127`	help: to link to the trait, prefix with `trait@`
`128`	`128`	`\|`
@@ -134,7 +134,7 @@ error: unresolved link to `Clone`
`134`	`134`	`--> $DIR/weird-syntax.rs:77:9`
`135`	`135`	`\|`
`136`	`136`	`LL \| /// [x][Clone ()]`
`137`		- \| ^^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`137`	+ \| ^^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`138`	`138`	`\|`
`139`	`139`	help: to link to the trait, prefix with `trait@`
`140`	`140`	`\|`
@@ -176,7 +176,7 @@ error: unresolved link to `Clone`
`176`	`176`	`--> $DIR/weird-syntax.rs:97:9`
`177`	`177`	`\|`
`178`	`178`	`LL \| /// [w](Clone\(\))`
`179`		- \| ^^^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`179`	+ \| ^^^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`180`	`180`	`\|`
`181`	`181`	help: to link to the trait, prefix with `trait@`
`182`	`182`	`\|`
@@ -188,7 +188,7 @@ error: unresolved link to `Clone`
`188`	`188`	`--> $DIR/weird-syntax.rs:103:9`
`189`	`189`	`\|`
`190`	`190`	`LL \| /// [w](Clone())`
`191`		- \| ^^^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`191`	+ \| ^^^^^^^ this link resolves to the trait `Clone`, which is not a function
`192`	`192`	`\|`
`193`	`193`	help: to link to the trait, prefix with `trait@`
`194`	`194`	`\|`
@@ -256,7 +256,7 @@ error: unresolved link to `Clone`
`256`	`256`	`--> $DIR/weird-syntax.rs:132:9`
`257`	`257`	`\|`
`258`	`258`	`LL \| /// The [cln][] link here will produce a plain text suggestion`
`259`		- \| ^^^^^ this link resolves to the trait `Clone`, which is not in the value namespace
	`259`	+ \| ^^^^^ this link resolves to the trait `Clone`, which is not a function
`260`	`260`	`\|`
`261`	`261`	= help: to link to the trait, prefix with `trait@`: trait@Clone
`262`	`262`