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 an equivalent of "--check" on rustdoc #76040

Closed
GuillaumeGomez opened this issue Aug 28, 2020 · 2 comments
Closed

Add an equivalent of "--check" on rustdoc #76040

GuillaumeGomez opened this issue Aug 28, 2020 · 2 comments
Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented Aug 28, 2020

In a recent conversation, it came up that cargo check wasn't running rustdoc lints. I then realized that there was no easy way to just run an equivalent of cargo check with rustdoc to get those lints. So the question is mostly: how should we do it? Extend cargo? Add an option on rustdoc and then call it through cargo?

cc @rust-lang/rustdoc

Also tagging @yaahc who brought up the issue.

@GuillaumeGomez GuillaumeGomez added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 28, 2020
@jyn514 jyn514 added the A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. label Aug 28, 2020
@jyn514
Copy link
Member

jyn514 commented Aug 28, 2020

Another thing mentioned is that it's not clear which lints belong to rustdoc and which belong to rustc. If we added doc:: in front it would be more clear the lints are only run with rustdoc.

@jyn514
Copy link
Member

jyn514 commented Jul 2, 2021

Added in #78984

@jyn514 jyn514 closed this as completed Jul 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-lint Area: Lints (warnings about flaws in source code) such as unused_mut. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants