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.

Sign up for GitHub

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

Jump to bottom

Error or warn on links that start with # and recommend self# or Self# instead #76545

Closed
camelid opened this issue Sep 9, 2020 · 2 comments
Closed

Error or warn on links that start with # and recommend self# or Self# instead #76545

camelid opened this issue Sep 9, 2020 · 2 comments
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@camelid
Copy link
Member

camelid commented Sep 9, 2020

Rustdoc should error or warn on links that start # and recommend self# for a module or Self# for a type.

Originally posted here and here.

Cc @jyn514

@rustbot modify labels: A-intra-doc-links T-rustdoc
@rustbot rustbot added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Sep 9, 2020
@camelid camelid mentioned this issue Sep 9, 2020
Merged
@jyn514
Copy link
Member

jyn514 commented Sep 9, 2020

Oops, we raced to open the issue. Closing in favor of #76546 which has more details.

@jyn514 jyn514 closed this as completed Sep 9, 2020
@camelid
Copy link
Member Author

camelid commented Sep 9, 2020

I thought Rust protected against races! 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jyn514 @camelid @rustbot