-
Notifications
You must be signed in to change notification settings - Fork 13k
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
rustdoc: resolve intra-doc links when checking HTML #93605
Merged
bors
merged 1 commit into
rust-lang:master
from
notriddle:notriddle/rustdoc-html-tags-resolve
Feb 20, 2022
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 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
25 changes: 25 additions & 0 deletions
25
src/test/rustdoc-ui/intra-doc/html-as-generics-intra-doc.rs
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,25 @@ | ||
#![deny(rustdoc::invalid_html_tags)] | ||
#![deny(rustdoc::broken_intra_doc_links)] | ||
|
||
pub struct ExistentStruct<T>(T); | ||
|
||
/// This [test][ExistentStruct<i32>] thing! | ||
pub struct NoError; | ||
|
||
/// This [ExistentStruct<i32>] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
pub struct PartialErrorOnlyHtml; | ||
|
||
/// This [test][NonExistentStruct<i32>] thing! | ||
//~^ ERROR unresolved link | ||
pub struct PartialErrorOnlyResolve; | ||
|
||
/// This [NonExistentStruct2<i32>] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
//~| ERROR unresolved link | ||
pub struct YesError; | ||
|
||
/// This [NonExistentStruct3<i32>][] thing! | ||
//~^ ERROR unclosed HTML tag `i32` | ||
//~| ERROR unresolved link | ||
pub struct YesErrorCollapsed; |
69 changes: 69 additions & 0 deletions
69
src/test/rustdoc-ui/intra-doc/html-as-generics-intra-doc.stderr
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,69 @@ | ||
error: unresolved link to `NonExistentStruct` | ||
--> $DIR/html-as-generics-intra-doc.rs:13:17 | ||
| | ||
LL | /// This [test][NonExistentStruct<i32>] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct` in scope | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/html-as-generics-intra-doc.rs:2:9 | ||
| | ||
LL | #![deny(rustdoc::broken_intra_doc_links)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unresolved link to `NonExistentStruct2` | ||
--> $DIR/html-as-generics-intra-doc.rs:17:11 | ||
| | ||
LL | /// This [NonExistentStruct2<i32>] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct2` in scope | ||
| | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unresolved link to `NonExistentStruct3` | ||
--> $DIR/html-as-generics-intra-doc.rs:22:11 | ||
| | ||
LL | /// This [NonExistentStruct3<i32>][] thing! | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ no item named `NonExistentStruct3` in scope | ||
| | ||
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:9:25 | ||
| | ||
LL | /// This [ExistentStruct<i32>] thing! | ||
| ^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/html-as-generics-intra-doc.rs:1:9 | ||
| | ||
LL | #![deny(rustdoc::invalid_html_tags)] | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
help: try marking as source code | ||
| | ||
LL | /// This [`ExistentStruct<i32>`] thing! | ||
| + + | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:17:29 | ||
| | ||
LL | /// This [NonExistentStruct2<i32>] thing! | ||
| ^^^^^ | ||
| | ||
help: try marking as source code | ||
| | ||
LL | /// This [`NonExistentStruct2<i32>`] thing! | ||
| + + | ||
|
||
error: unclosed HTML tag `i32` | ||
--> $DIR/html-as-generics-intra-doc.rs:22:29 | ||
| | ||
LL | /// This [NonExistentStruct3<i32>][] thing! | ||
| ^^^^^ | ||
| | ||
help: try marking as source code | ||
| | ||
LL | /// This [`NonExistentStruct3<i32>`][] thing! | ||
| + + | ||
|
||
error: aborting due to 6 previous errors | ||
|
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 seems like it might be kind of slow... maybe worth addressing in the future (not in this PR).
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.
We will run a perf check just to be sure the impact isn't too big, otherwise it'll have to be fixed in this PR (good catch!).