Add more explanatory text to the C-LINK section#220
Merged
KodrAus merged 1 commit intorust-lang:masterfrom Dec 22, 2020
Merged
Conversation
The new text explains how to add regular markdown links and how to add link targets. In particular it makes it clear that rustdoc link targets go at the end of the docstring rather than inline.
Contributor
Author
|
This came out of my confusion in rust-lang/rust#71680. It took me a while to figure out how to fix the links in that docstring because it's quite long, so I didn't notice that the link targets go at the very end. I'm still a little confused because the link targets in the rust source code don't look like the examples in this doc. See https://doc.rust-lang.org/src/core/cmp.rs.html#194 for example. It shows links to trait methods as |
KodrAus
approved these changes
Dec 22, 2020
Contributor
KodrAus
left a comment
There was a problem hiding this comment.
Thanks @nicholasbishop! This looks good to me
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 new text explains how to add regular markdown links and how to add
link targets. In particular it makes it clear that rustdoc link
targets go at the end of the docstring rather than inline.