Intra-doc links #497
Merged
Intra-doc links #497
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
This commit changes all the documentation to use intra-doc links, which were stabilized in rust 1.48. This helps to avoid broken links in crates that depend on this one. fixes rust-itertools#496
phimuemue
reviewed
Nov 26, 2020
Comment on lines
-282
to
-283
| /// [`multizip`]: fn.multizip.html | ||
| /// |
There was a problem hiding this comment.
Could you explain why this commit removes some lines?
There was a problem hiding this comment.
In markdown if you write [foo] without defining [foo]: bar or writing [foo](bar), the link will go directly to foo. That means that if the text of the link happens to already be valid according to intra-doc link rules, there is no need to provide a custom link target (this line would end up reading [`multizip`]: multizip and rustdoc knows enough to strip the backticks).
jswrenn
approved these changes
Dec 27, 2020
bors bot
added a commit
that referenced
this pull request
Dec 27, 2020
497: Intra-doc links r=jswrenn a=digama0 This commit changes all the documentation to use intra-doc links, which were stabilized in rust 1.48. This helps to avoid broken links in crates that depend on this one. fixes #496 Co-authored-by: Mario Carneiro <[email protected]>
|
Build failed: |
|
Huh. I'm really not sure what to make of this build "failure". Everything appears to have passed. |
|
bors retry |
bors bot
added a commit
that referenced
this pull request
Dec 28, 2020
497: Intra-doc links r=jswrenn a=digama0 This commit changes all the documentation to use intra-doc links, which were stabilized in rust 1.48. This helps to avoid broken links in crates that depend on this one. fixes #496 Co-authored-by: Mario Carneiro <[email protected]>
|
Build failed: |
|
bors retry |
|
Build succeeded: |
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 commit changes all the documentation to use intra-doc links, which
were stabilized in rust 1.48. This helps to avoid broken links in crates
that depend on this one.
fixes #496