Uh oh!
There was an error while loading. Please reload this page.
Add lint when no doc is present at the crate-level - #66938
Conversation
jonas-schievink
left a comment
There was a problem hiding this comment.
Not sure what the motivation for this is given that we already have a missing docs lint
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
GuillaumeGomez
commented
Dec 2, 2019
@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... |
kinnison
left a comment
There was a problem hiding this comment.
A couple of potential wording tweaks in addition to the other comments.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
bors
commented
Dec 23, 2019
☔ The latest upstream changes (presumably #67540) made this pull request unmergeable. Please resolve the merge conflicts. |
joelpalmer
commented
Jan 6, 2020
Ping from Triage: any updates @GuillaumeGomez? |
GuillaumeGomez
commented
Jan 6, 2020
I need to update the PR. Lack of time lately... |
JohnTitor
commented
Feb 2, 2020
Ping from triage: @GuillaumeGomez any updates on this? This PR is idle for about two months. |
GuillaumeGomez
commented
Feb 2, 2020
Forgot about it... I'll try to get back to it "soon". |
93a12ca to
9f3d60dCompareGuillaumeGomez
commented
Feb 11, 2020
Updated! |
rust-highfive
commented
Feb 11, 2020
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 |
petrochenkov
commented
Feb 11, 2020
This PR is still missing motivation. If the lint is not enabled by default, then we already have |
GuillaumeGomez
commented
Feb 11, 2020
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
15dbb84Comparerust-highfive
commented
Feb 11, 2020
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
d842bdbCompareGuillaumeGomez
commented
Feb 12, 2020
Oh, the lint sentence changed, nice. |
d842bdb to
4d822acCompareGuillaumeGomez
commented
Feb 15, 2020
Ping @kinnison |
4d822ac to
be97eb4CompareGuillaumeGomez
commented
Mar 22, 2020
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. |
Dylan-DPC-zz
commented
Mar 23, 2020
@bors r+ |
bors
commented
Mar 23, 2020
📌 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
Dylan-DPC-zz
commented
Mar 23, 2020
eh sorry forgot to refresh the tab :D @bors r- |
GuillaumeGomez
commented
Mar 28, 2020
? |
Dylan-DPC-zz
commented
Mar 28, 2020
@bors r+ |
bors
commented
Mar 28, 2020
📌 Commit be97eb4 has been approved by |
bors
commented
Mar 28, 2020
bors
commented
Mar 28, 2020
☀️ Test successful - checks-azure |
Follow-up of #66267.
r? @kinnison