Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more explanatory text to the C-LINK section #220

Merged
merged 1 commit into from
Dec 22, 2020

Conversation

nicholasbishop
Copy link
Contributor

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.

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.
@nicholasbishop
Copy link
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 [`eq`]: PartialEq::eq, which doesn't match any of the examples given in the C-LINK section.

@KodrAus KodrAus added the amendment Amendments to existing guidelines label Dec 22, 2020
Copy link
Contributor

@KodrAus KodrAus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @nicholasbishop! This looks good to me

@KodrAus KodrAus merged commit 7e4dca3 into rust-lang:master Dec 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
amendment Amendments to existing guidelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants