-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Add new tyalias
intra-doc link disambiguator
#147027
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
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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
Some comments aren't visible on the classic Files Changed page.
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
21 changes: 21 additions & 0 deletions
21
tests/rustdoc-ui/intra-doc/type-alias-primitive-suggestion.rs
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,21 @@ | ||
// Ensure that no warning is emitted if the disambiguator is used for type alias. | ||
// Regression test for <https://github.com/rust-lang/rust/issues/146855>. | ||
|
||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
pub struct Foo; | ||
|
||
#[allow(non_camel_case_types)] | ||
pub type f32 = Foo; | ||
|
||
/// This function returns [`f32`]. | ||
//~^ ERROR: `f32` is both a type alias and a primitive type | ||
//~| HELP: to link to the type alias, prefix with `tyalias@` | ||
//~| HELP: to link to the primitive type, prefix with `prim@` | ||
pub fn my_fn() -> f32 {} | ||
|
||
/// This function returns [type@f32]. | ||
//~^ ERROR: `f32` is both a type alias and a primitive type | ||
//~| HELP: to link to the type alias, prefix with `tyalias@` | ||
//~| HELP: to link to the primitive type, prefix with `prim@` | ||
pub fn my_fn2() -> f32 {} |
39 changes: 39 additions & 0 deletions
39
tests/rustdoc-ui/intra-doc/type-alias-primitive-suggestion.stderr
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,39 @@ | ||
error: `f32` is both a type alias and a primitive type | ||
--> $DIR/type-alias-primitive-suggestion.rs:11:29 | ||
| | ||
LL | /// This function returns [`f32`]. | ||
| ^^^ ambiguous link | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/type-alias-primitive-suggestion.rs:4:9 | ||
| | ||
LL | #![deny(rustdoc::broken_intra_doc_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: to link to the type alias, prefix with `tyalias@` | ||
| | ||
LL | /// This function returns [`tyalias@f32`]. | ||
| ++++++++ | ||
help: to link to the primitive type, prefix with `prim@` | ||
| | ||
LL | /// This function returns [`prim@f32`]. | ||
| +++++ | ||
|
||
error: `f32` is both a type alias and a primitive type | ||
--> $DIR/type-alias-primitive-suggestion.rs:17:28 | ||
| | ||
LL | /// This function returns [type@f32]. | ||
| ^^^^^^^^ ambiguous link | ||
| | ||
help: to link to the type alias, prefix with `tyalias@` | ||
| | ||
LL - /// This function returns [type@f32]. | ||
LL + /// This function returns [tyalias@f32]. | ||
| | ||
help: to link to the primitive type, prefix with `prim@` | ||
| | ||
LL - /// This function returns [type@f32]. | ||
LL + /// This function returns [prim@f32]. | ||
| | ||
|
||
error: aborting due to 2 previous errors | ||
|
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,14 @@ | ||
// Ensure that no warning is emitted if the disambiguator is used for type alias. | ||
// Regression test for <https://github.com/rust-lang/rust/issues/146855>. | ||
|
||
//@ check-pass | ||
|
||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
pub struct Foo; | ||
|
||
#[allow(non_camel_case_types)] | ||
pub type f32 = Foo; | ||
|
||
/// This function returns [`tyalias@f32`] and not [`prim@f32`]. | ||
pub fn my_fn() -> f32 {} |
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,21 @@ | ||
// Ensure that no warning is emitted if the disambiguator is used for type alias. | ||
// Regression test for <https://github.com/rust-lang/rust/issues/146855>. | ||
|
||
#![crate_name = "foo"] | ||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
pub struct Foo; | ||
|
||
#[allow(non_camel_case_types)] | ||
pub type f32 = Foo; | ||
|
||
/// This function returns [`tyalias@f32`] and not [bla][`prim@f32`]. | ||
//@ has 'foo/fn.my_fn.html' | ||
//@ has - '//a[@href="type.f32.html"]' "f32" | ||
//@ has - '//a[@href="{{channel}}/std/primitive.f32.html"]' "bla" | ||
pub fn my_fn() -> f32 { 0. } | ||
|
||
/// This function returns [`typealias@f32`]. | ||
//@ has 'foo/fn.my_other_fn.html' | ||
//@ has - '//a[@href="type.f32.html"]' "f32" | ||
pub fn my_other_fn() -> f32 { 0. } |
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.
What happens if we link to
type@f32
? It would be nice to also check that case.