-
Notifications
You must be signed in to change notification settings - Fork 12.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #131224 - notriddle:notriddle/intra-doc-link-value, r=G…
…uillaumeGomez rustdoc: prevent ctors from resolving Fixes #130591
- Loading branch information
Showing
5 changed files
with
105 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
// https://github.com/rust-lang/rust/issues/130591 | ||
#![deny(rustdoc::broken_intra_doc_links)] | ||
#![crate_name = "foo"] | ||
|
||
/// [value@Foo::X] //~ERROR broken | ||
pub enum Foo { | ||
X, | ||
} | ||
|
||
/// [tst][value@MyStruct] //~ERROR broken | ||
pub struct MyStruct; | ||
|
||
pub enum MyEnum { | ||
Internals, | ||
} | ||
|
||
pub use MyEnum::*; | ||
|
||
/// In this context, [a][type@Internals] is a struct, | ||
/// while [b][value@Internals] fails. //~ERROR broken | ||
/// Also, [c][struct@Internals] is a struct, | ||
/// while [d][variant@Internals] fails. //~ERROR broken | ||
pub struct Internals { | ||
foo: (), | ||
} | ||
|
||
pub mod inside { | ||
pub struct Internals2; | ||
} | ||
|
||
use inside::*; | ||
|
||
/// In this context, [a][type@Internals2] is an enum, | ||
/// while [b][value@Internals2] fails. //~ERROR broken | ||
pub enum Internals2 {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
error: unresolved link to `Foo::X` | ||
--> $DIR/value-ctor.rs:5:6 | ||
| | ||
LL | /// [value@Foo::X] | ||
| ^^^^^^^^^^^^ this link resolves to the variant `X`, which is not in the value namespace | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/value-ctor.rs:2:9 | ||
| | ||
LL | #![deny(rustdoc::broken_intra_doc_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: to link to the variant, prefix with `variant@` | ||
| | ||
LL | /// [variant@Foo::X] | ||
| ~~~~~~~~ | ||
|
||
error: unresolved link to `MyStruct` | ||
--> $DIR/value-ctor.rs:10:11 | ||
| | ||
LL | /// [tst][value@MyStruct] | ||
| ^^^^^^^^^^^^^^ this link resolves to the struct `MyStruct`, which is not in the value namespace | ||
| | ||
help: to link to the struct, prefix with `struct@` | ||
| | ||
LL | /// [tst][struct@MyStruct] | ||
| ~~~~~~~ | ||
|
||
error: unresolved link to `Internals` | ||
--> $DIR/value-ctor.rs:20:15 | ||
| | ||
LL | /// while [b][value@Internals] fails. | ||
| ^^^^^^^^^^^^^^^ this link resolves to the struct `Internals`, which is not in the value namespace | ||
| | ||
help: to link to the struct, prefix with `struct@` | ||
| | ||
LL | /// while [b][struct@Internals] fails. | ||
| ~~~~~~~ | ||
|
||
error: incompatible link kind for `Internals` | ||
--> $DIR/value-ctor.rs:22:15 | ||
| | ||
LL | /// while [d][variant@Internals] fails. | ||
| ^^^^^^^^^^^^^^^^^ this link resolved to a struct, which is not a variant | ||
| | ||
help: to link to the struct, prefix with `struct@` | ||
| | ||
LL | /// while [d][struct@Internals] fails. | ||
| ~~~~~~~ | ||
|
||
error: unresolved link to `Internals2` | ||
--> $DIR/value-ctor.rs:34:15 | ||
| | ||
LL | /// while [b][value@Internals2] fails. | ||
| ^^^^^^^^^^^^^^^^ this link resolves to the enum `Internals2`, which is not in the value namespace | ||
| | ||
help: to link to the enum, prefix with `enum@` | ||
| | ||
LL | /// while [b][enum@Internals2] fails. | ||
| ~~~~~ | ||
|
||
error: aborting due to 5 previous errors | ||
|