-
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
Improve rustdoc error for failed intra-doc link resolution #77469
Merged
bors
merged 4 commits into
rust-lang:master
from
camelid:rustdoc-better-failed-res-error
Oct 4, 2020
Merged
Improve rustdoc error for failed intra-doc link resolution #77469
bors
merged 4 commits into
rust-lang:master
from
camelid:rustdoc-better-failed-res-error
Oct 4, 2020
Conversation
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
The previous error was confusing since it made it sound like you can't link to items that are defined outside the current module. Also suggested importing the item.
This comment has been minimized.
This comment has been minimized.
rust-highfive
added
the
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
label
Oct 2, 2020
jyn514
added
A-intra-doc-links
Area: Intra-doc links, the ability to link to items in docs by name
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
labels
Oct 2, 2020
camelid
added
A-diagnostics
Area: Messages for errors, warnings, and lints
D-confusing
Diagnostics: Confusing error or lint that should be reworked.
and removed
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
labels
Oct 2, 2020
camelid
commented
Oct 2, 2020
jyn514
reviewed
Oct 2, 2020
The new error was confusing when there was partial resolution (something like `std::io::nonexistent`); the old one is better for those cases.
camelid
commented
Oct 3, 2020
camelid
added
the
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
label
Oct 3, 2020
Huh, GitHub's labels have been acting up recently; it shows that I removed |
Yeah, this looks a lot better. r=me with CI passing. |
@bors r+ Thanks for working on this! |
📌 Commit aa9b718 has been approved by |
bors
added
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
and removed
S-waiting-on-review
Status: Awaiting review from the assignee but also interested parties.
labels
Oct 3, 2020
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Oct 3, 2020
…rror, r=jyn514 Improve rustdoc error for failed intra-doc link resolution The previous error was confusing since it made it sound like you can't link to items that are defined outside the current module. Also suggested importing the item. r? @jyn514
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 4, 2020
Rollup of 11 pull requests Successful merges: - rust-lang#75143 (Use `tracing` spans to trace the entire MIR interp stack) - rust-lang#75699 (Uplift drop-bounds lint from clippy) - rust-lang#76768 (Test and reject out-of-bounds shuffle vectors) - rust-lang#77190 (updated p! macro to accept literals) - rust-lang#77388 (Add some regression tests) - rust-lang#77419 (Create E0777 error code for invalid argument in derive) - rust-lang#77447 (BTreeMap: document DrainFilterInner better) - rust-lang#77468 (Fix test name) - rust-lang#77469 (Improve rustdoc error for failed intra-doc link resolution) - rust-lang#77473 (Make --all-targets in x.py check opt-in) - rust-lang#77508 (Fix capitalization in blog post name) Failed merges: r? `@ghost`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
A-diagnostics
Area: Messages for errors, warnings, and lints
A-intra-doc-links
Area: Intra-doc links, the ability to link to items in docs by name
D-confusing
Diagnostics: Confusing error or lint that should be reworked.
S-waiting-on-bors
Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
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.
The previous error was confusing since it made it sound like you can't
link to items that are defined outside the current module.
Also suggested importing the item.
r? @jyn514