Add list of supported disambiguators and suffixes for intra-doc links in the rustdoc book #110348
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
rustbot
added
the
S-waiting-on-review
|
cc @Manishearth , I remember last time I suggested adding this you thought having it in the error messages was enough. |
jyn514
added
T-rustdoc
|
It's what I thought too and then I re-discovered the auto-disambiguation of trait and derive proc-macro and because of this, I think providing the list of disambiguators is now something we must provide. But even before that, providing the list of disambiguators seems like something we should provide just so that people aren't surprised when they see them. Having an "official list" is always a good thing imo. |
|
Here’s where the disambiguators are actually implemented: https://github.com/rust-lang/rust/blob/master/src/librustdoc/passes/collect_intra_doc_links.rs#L1416 Perhaps add a comment there reminding anyone adding a new disambiguator to also update the book? |
|
Good idea! |
|
Added code comments. |
Manishearth
reviewed
Apr 15, 2023
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
Outdated
Show resolved
Hide resolved
Manishearth
reviewed
Apr 15, 2023
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
Outdated
Show resolved
Hide resolved
GuillaumeGomez
force-pushed
the
disambiguators-suffixes-rustdoc-book
branch
from
bef32f4
to
fbc7696
Compare
|
Updated as suggested. |
notriddle
approved these changes
Apr 16, 2023
Manishearth
reviewed
Apr 16, 2023
src/doc/rustdoc/src/write-documentation/linking-to-items-by-name.md
Outdated
Show resolved
Hide resolved
… in the rustdoc book
…y update the disambiguators list
GuillaumeGomez
force-pushed
the
disambiguators-suffixes-rustdoc-book
branch
from
fbc7696
to
1531c95
Compare
|
Applied suggestion. |
Manishearth
approved these changes
Apr 17, 2023
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Apr 17, 2023
…ixes-rustdoc-book, r=Manishearth Add list of supported disambiguators and suffixes for intra-doc links in the rustdoc book This information is otherwise only provided in case an error occurs, which isn't great. r? `@notriddle`
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Apr 17, 2023
…ixes-rustdoc-book, r=Manishearth Add list of supported disambiguators and suffixes for intra-doc links in the rustdoc book This information is otherwise only provided in case an error occurs, which isn't great. r? ``@notriddle``
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Apr 18, 2023
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#109981 (Set commit information environment variables when building tools) - rust-lang#110348 (Add list of supported disambiguators and suffixes for intra-doc links in the rustdoc book) - rust-lang#110409 (Don't use `serde_json` to serialize a simple JSON object) - rust-lang#110442 (Avoid including dry run steps in the build metrics) - rust-lang#110450 (rustdoc: Fix invalid handling of nested items with `--document-private-items`) - rust-lang#110461 (Use `Item::expect_*` and `ImplItem::expect_*` more) - rust-lang#110465 (Assure everyone that `has_type_flags` is fast) 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.
This information is otherwise only provided in case an error occurs, which isn't great.
r? @notriddle