Lint on unknown intra-doc link disambiguators #83543
Merged
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
camelid
added
A-intra-doc-links
|
Some changes occurred in intra-doc-links. cc @jyn514 |
|
r? @jyn514 (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
camelid
force-pushed
the
lint-unknown-disambiguator
branch
from
922b888
to
0ffc9b3
Compare
camelid
commented
Mar 27, 2021
This comment has been minimized.
This comment has been minimized.
camelid
force-pushed
the
lint-unknown-disambiguator
branch
from
0ffc9b3
to
4572e7f
Compare
jyn514
reviewed
Mar 27, 2021
camelid
added
S-waiting-on-author
And, now that we do that, we can remove the explanatory note since the error span should make it clear what the disambiguator is.
camelid
added
S-waiting-on-review
camelid
commented
Mar 29, 2021
Comment on lines
+14
to
+36
| error: unknown disambiguator `bar` | ||
| --> $DIR/unknown-disambiguator.rs:3:35 | ||
| | | ||
| LL | //! Linking to [foo@banana] and [`bar@banana!()`]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `foo` | ||
| --> $DIR/unknown-disambiguator.rs:9:34 | ||
| | | ||
| LL | //! And with weird backticks: [``foo@hello``] [foo`@`hello]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `foo` | ||
| --> $DIR/unknown-disambiguator.rs:9:48 | ||
| | | ||
| LL | //! And with weird backticks: [``foo@hello``] [foo`@`hello]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `` | ||
| --> $DIR/unknown-disambiguator.rs:6:31 | ||
| | | ||
| LL | //! And to [no disambiguator](@nectarine) and [another](@apricot!()). | ||
| | ^ |
There was a problem hiding this comment.
I don't think this is caused by my change, but any idea why it's reporting diagnostics for line 3, then line 9, and then back to line 6? It's kind of confusing that they're out of order.
There was a problem hiding this comment.
I'm not sure, sorry. Probably it's something to do with how pulldown-cmark returns the links.
camelid
force-pushed
the
lint-unknown-disambiguator
branch
from
091f43f
to
141df6f
Compare
jyn514
approved these changes
Mar 29, 2021
Comment on lines
+14
to
+36
| error: unknown disambiguator `bar` | ||
| --> $DIR/unknown-disambiguator.rs:3:35 | ||
| | | ||
| LL | //! Linking to [foo@banana] and [`bar@banana!()`]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `foo` | ||
| --> $DIR/unknown-disambiguator.rs:9:34 | ||
| | | ||
| LL | //! And with weird backticks: [``foo@hello``] [foo`@`hello]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `foo` | ||
| --> $DIR/unknown-disambiguator.rs:9:48 | ||
| | | ||
| LL | //! And with weird backticks: [``foo@hello``] [foo`@`hello]. | ||
| | ^^^ | ||
|
|
||
| error: unknown disambiguator `` | ||
| --> $DIR/unknown-disambiguator.rs:6:31 | ||
| | | ||
| LL | //! And to [no disambiguator](@nectarine) and [another](@apricot!()). | ||
| | ^ |
There was a problem hiding this comment.
I'm not sure, sorry. Probably it's something to do with how pulldown-cmark returns the links.
Comment on lines
+1507
to
+1513
| let after_first_backtick_group = ori_link.link.bytes().position(|b| b != b'`').unwrap_or(0); | ||
| let before_second_backtick_group = ori_link | ||
| .link | ||
| .bytes() | ||
| .skip(after_first_backtick_group) | ||
| .position(|b| b == b'`') | ||
| .unwrap_or(ori_link.link.len()); |
There was a problem hiding this comment.
I think this will break on things like
[`a`b`c`]
but that seems fine, that's an awful abuse of rustdoc.
There was a problem hiding this comment.
It actually works correctly! But I imagine there are some edge cases that don't work correctly.
error: unknown disambiguator `foo`
--> src/test/rustdoc-ui/intra-doc/unknown-disambiguator.rs:12:7
|
12 | //! [`foo@`b`c`]
| ^^^
|
@bors r+ |
|
📌 Commit 141df6f has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Mar 29, 2021
… r=jyn514 Lint on unknown intra-doc link disambiguators
This was referenced Mar 29, 2021
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 30, 2021
Rollup of 7 pull requests Successful merges: - rust-lang#82331 (alloc: Added `as_slice` method to `BinaryHeap` collection) - rust-lang#83130 (escape_ascii take 2) - rust-lang#83374 (unix: Fix feature(unix_socket_ancillary_data) on macos and other BSDs) - rust-lang#83543 (Lint on unknown intra-doc link disambiguators) - rust-lang#83636 (Add a regression test for issue-82792) - rust-lang#83643 (Remove a FIXME resolved by rust-lang#73578) - rust-lang#83644 (:arrow_up: rust-analyzer) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.