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

Lint hand-written intra-rustdoc links #1912

Open
clarfonthey opened this issue Jul 31, 2017 · 3 comments
Open

Lint hand-written intra-rustdoc links #1912

clarfonthey opened this issue Jul 31, 2017 · 3 comments
Labels
A-lint Area: New lints L-style Lint: Belongs in the style lint group

Comments

@clarfonthey
Copy link
Contributor

Once rust-lang/rust#43466 lands, people will be able to write links directly to Rust items instead of hand-writing the links. We should consider at some point adding a lint that will look for links to items and lint to use the latter format instead.

Obviously, we'd want to wait before this is implemented in compiler land before linting, but it's good to add to the list.

@oli-obk oli-obk added L-style Lint: Belongs in the style lint group A-documentation Area: Adding or improving documentation labels Aug 1, 2017
@killercup
Copy link
Member

killercup commented Aug 3, 2017

rust-lang/rfcs#1946 is merged! The implementation is still quite some time away, though.

In the meantime, cf. #1007 (comment) for some more thought and links on documentation lints.

@sharksforarms
Copy link

Landed in 1.48: rust-lang/rust#43466

@jyn514
Copy link
Member

jyn514 commented Aug 5, 2021

Once rust-lang/rust#43466 lands, people will be able to write links directly to Rust items instead of hand-writing the links. We should consider at some point adding a lint that will look for links to items and lint to use the latter format instead.

See also the rustdoc issue for this: rust-lang/rust#75805

@camsteffen camsteffen added A-lint Area: New lints and removed A-documentation Area: Adding or improving documentation labels Nov 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-lint Area: New lints L-style Lint: Belongs in the style lint group
Projects
None yet
Development

No branches or pull requests

6 participants