-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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 lint when no doc is present at the crate-level #66938
Add lint when no doc is present at the crate-level #66938
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what the motivation for this is given that we already have a missing docs lint
@jonas-schievink I'd like to have this lint activated at the warning level by default once we all agree on it (and once the rustdoc book page is stable too). The idea is to provide some help by default for people that don't know how to write documentation. Hmmm... Maybe I should have written that in the PR description... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of potential wording tweaks in addition to the other comments.
☔ The latest upstream changes (presumably #67540) made this pull request unmergeable. Please resolve the merge conflicts. |
Ping from Triage: any updates @GuillaumeGomez? |
I need to update the PR. Lack of time lately... |
Ping from triage: @GuillaumeGomez any updates on this? This PR is idle for about two months. |
Forgot about it... I'll try to get back to it "soon". |
93a12ca
to
9f3d60d
Compare
Updated! |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
This PR is still missing motivation. If the lint is not enabled by default, then we already have |
The motivation is providing help for a specific kind of documentation. It'll also be set as warning by default. As a sidenote, need to check what failed the tests... |
9f3d60d
to
15dbb84
Compare
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
15dbb84
to
d842bdb
Compare
Oh, the lint sentence changed, nice. |
d842bdb
to
4d822ac
Compare
Ping @kinnison |
4d822ac
to
be97eb4
Compare
It'll be visible only when running rustdoc, so unless you want to document your API, you'll never this warning.
If you see this warning, it means that you're trying to get your API documentation. At this point, if you don't know about how to document rust code, it'll come in handy. Otherwise, you can either ignore the lint or allow it. In any case, it won't impact much people who don't have the need for it. |
@bors r+ |
📌 Commit be97eb4 has been approved by |
…vel-doc, r=Dylan-DPC Add lint when no doc is present at the crate-level Follow-up of rust-lang#66267. r? @kinnison
…vel-doc, r=Dylan-DPC Add lint when no doc is present at the crate-level Follow-up of rust-lang#66267. r? @kinnison
eh sorry forgot to refresh the tab :D @bors r- |
? |
@bors r+ |
📌 Commit be97eb4 has been approved by |
☀️ Test successful - checks-azure |
Follow-up of #66267.
r? @kinnison