Prefer full reference links for intra-doc links #117178
Closed
Conversation
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
|
(rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
the
S-waiting-on-review
|
Discussion on zulip is here. I added it to the rustdoc team agenda so it can be discussed. |
|
Any updates on this? |
|
It's still in the "to discuss" items list. Sorry, we don't go through very fast. ^^' |
fmease
added
T-rustdoc
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Feb 13, 2024
…nk-chapter, r=notriddle Extend intra-doc link chapter in the rustdoc book Linked to rust-lang#117178. r? `@notriddle`
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Feb 13, 2024
Rollup merge of rust-lang#121021 - GuillaumeGomez:extend-intra-doc-link-chapter, r=notriddle Extend intra-doc link chapter in the rustdoc book Linked to rust-lang#117178. r? `@notriddle`
|
We decided in the last rustdoc meeting on zulip to not favor one syntax over the other. Instead we added a section in the rustdoc book mentioning what both syntaxes will result into (#121021). Thanks for bringing this to our attention and for your work! We hope to see you again. :) |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Unlike the RFC, Rustdoc supports interpreting full reference links as intra-doc links. It might make sense to prefer this over inline links as they might also imply a URL.
I'm happy to apply this preference across the code base, though a implementing a lint first might be preferable.