overhaul unused doc comments lint #57882
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
r? @estebank |
|
@bors r+ |
|
📌 Commit 871e460 has been approved by |
bors
added
S-waiting-on-bors
Centril
added a commit
to Centril/rust
that referenced
this pull request
Jan 26, 2019
…ebank overhaul unused doc comments lint This PR contains a number of improvements to the `unused_doc_comments` lint. - Extends the span to cover the entire comment when using sugared doc comments. - Triggers the lint for all unused doc comments on a node, instead of just the first one. - Triggers the lint on macro expansions, and provides a help note explaining that doc comments must be expanded by the macro. - Adds a label pointing at the node that cannot be documented. Furthermore, this PR fixes any instances in rustc where a macro expansion was erroneously documented.
Centril
added a commit
to Centril/rust
that referenced
this pull request
Jan 26, 2019
…ebank overhaul unused doc comments lint This PR contains a number of improvements to the `unused_doc_comments` lint. - Extends the span to cover the entire comment when using sugared doc comments. - Triggers the lint for all unused doc comments on a node, instead of just the first one. - Triggers the lint on macro expansions, and provides a help note explaining that doc comments must be expanded by the macro. - Adds a label pointing at the node that cannot be documented. Furthermore, this PR fixes any instances in rustc where a macro expansion was erroneously documented.
|
☔ The latest upstream changes (presumably #57726) made this pull request unmergeable. Please resolve the merge conflicts. |
bors
added
S-waiting-on-author
This comment has been minimized.
This comment has been minimized.
euclio
force-pushed
the
unused-doc-attributes
branch
from
871e460
to
75d30fd
Compare
|
@estebank Rebased. |
|
⌛ Trying commit 75d30fd9401bd8f341ca82626edf61ca8e4ddd28 with merge 58c1b81ef6055246e8b6467f767b2e3c1ce4403b... |
|
☀️ Test successful - checks-travis |
euclio
force-pushed
the
unused-doc-attributes
branch
from
75d30fd
to
930c6c8
Compare
|
@estebank rebased. Did we ever get a crater run going for this? |
|
☔ The latest upstream changes (presumably #58316) made this pull request unmergeable. Please resolve the merge conflicts. |
euclio
force-pushed
the
unused-doc-attributes
branch
from
930c6c8
to
1b5f2c7
Compare
|
@estebank Rebased. |
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Mar 2, 2019
allow specifying attributes for tool lints Needed for clippy to fix `unused_doc_comments` warnings that will be exposed by rust-lang#57882 (and thus unblock it).
Mark-Simulacrum
added a commit
to Mark-Simulacrum/rust
that referenced
this pull request
Mar 2, 2019
allow specifying attributes for tool lints Needed for clippy to fix `unused_doc_comments` warnings that will be exposed by rust-lang#57882 (and thus unblock it).
|
☔ The latest upstream changes (presumably #58505) made this pull request unmergeable. Please resolve the merge conflicts. |
euclio
force-pushed
the
unused-doc-attributes
branch
from
b5fadf0
to
8edbc64
Compare
bors
added a commit
to rust-lang/rust-clippy
that referenced
this pull request
Mar 6, 2019
move lint documentation into macro invocations This PR moves lint documentation inside `declare_clippy_lint!` macro invocations, to avoid triggering the `unused_doc_comments` lint once it's modified in rust-lang/rust#57882. This PR is necessary to unblock that work, since the large number of warnings generated in `clippy_lints` causes Travis to hit the log length limit. This PR also updates the documentation and website generation script. It would be nice to get a clippy update in the Rust repo once this is merged. cc @phansch
Closed
|
☔ The latest upstream changes (presumably #58583) made this pull request unmergeable. Please resolve the merge conflicts. |
|
@euclio The Clippy submodule should now contain the changes to make this pass. |
Report all unused attributes on a given doc comment instead of just the first one, and extend the span of sugared doc comments to encompass the whole comment.
Report the diagnostic on macro expansions, and add a label indicating why the comment is unused.
euclio
force-pushed
the
unused-doc-attributes
branch
from
8edbc64
to
daf80f7
Compare
|
@estebank Ok, let's give this another shot! |
|
@bors r+ |
|
📌 Commit daf80f7 has been approved by |
bors
added
S-waiting-on-bors
bors
added a commit
that referenced
this pull request
Mar 9, 2019
overhaul unused doc comments lint This PR contains a number of improvements to the `unused_doc_comments` lint. - Extends the span to cover the entire comment when using sugared doc comments. - Triggers the lint for all unused doc comments on a node, instead of just the first one. - Triggers the lint on macro expansions, and provides a help note explaining that doc comments must be expanded by the macro. - Adds a label pointing at the node that cannot be documented. Furthermore, this PR fixes any instances in rustc where a macro expansion was erroneously documented.
|
☀️ Test successful - checks-travis, status-appveyor |
This was referenced Mar 9, 2019
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Apr 22, 2020
Clarify unused_doc_comments note on macro invocations The previous error message used to say: <pre> /// doc ^^^^^^^ rustdoc does not generate documentation for <b>macros</b> </pre> Obviously we do generate documentation for macros, such as https://docs.rs/bitflags/1.2.1/bitflags/macro.bitflags.html. It's only macro invocations that don't get their own docs. This PR updates the message to say "rustdoc does not generate documentation for <b>macro invocations</b>". I observe that prior to rust-lang#69084 this used to say "rustdoc does not generate documentation for **macro expansions**", as implemented originally in rust-lang#57882. I don't have a preference between those but I made the commit before looking up the history. r? @Manishearth attn: @yaahc @euclio
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains a number of improvements to the
unused_doc_commentslint.Furthermore, this PR fixes any instances in rustc where a macro expansion was erroneously documented.