-
Notifications
You must be signed in to change notification settings - Fork 13.3k
rustdoc: prevent ctors from resolving #131224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bors
merged 1 commit into
rust-lang:master
from
notriddle:notriddle/intra-doc-link-value
Oct 4, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this diagnostic change seems like a regression.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arf indeed. I was too happy about the fix and went too fast over this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be clear, I went with an approach where rustdoc mostly pretends that ctors don't exist at all because:
struct@
andvariant@
check both the type and value ns's would've cause a perf regression.ctor@
disambiguator would've been way too much feature for something that only matters if you do a globuse
shadowing hack.