Warn on #![doc(test(...))] on items other than the crate root and use future incompatible lint
#82708
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
GuillaumeGomez
added
the
T-rustdoc
rust-highfive
added
the
S-waiting-on-review
pickfire
reviewed
Mar 3, 2021
|
@Manishearth This error should be a warning too. Do you have suggestion for an existing lint I could use here maybe? |
|
@GuillaumeGomez Yes. I think we should create a combined INVALID_DOC_ATTRIBUTE future incompat lint in #82730 |
|
Ok, might be worth doing it in this PR directly then. Or do you prefer in another PR? |
|
r? @Manishearth |
|
@GuillaumeGomez Fine either way, but please use the future incompat infrastructure (it's a different kind of lint) |
|
Ok, going to update this PR as soon as possible then! |
|
Good point. I updated the PR description and I will open another PR which takes the meta item list and run the checks on them. |
jyn514
changed the title
#![doc(test(...))] on items other than the crate root
GuillaumeGomez
force-pushed
the
doc-test-attr-check
branch
2 times, most recently
from
4c32ac1
to
dbf39f3
Compare
|
I added the lint with the "future incompatible" as requested. It now warns by default. |
Manishearth
approved these changes
Mar 3, 2021
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
doc-test-attr-check
branch
from
dbf39f3
to
7942bda
Compare
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
doc-test-attr-check
branch
from
7942bda
to
f447cd0
Compare
This comment has been minimized.
This comment has been minimized.
GuillaumeGomez
force-pushed
the
doc-test-attr-check
branch
from
f447cd0
to
4400ec0
Compare
|
Can we also use this lint for #82702 ? |
|
@Manishearth Sure, do you want me to add it in this PR as well? |
|
Yes please! (and update the PR body/title) |
GuillaumeGomez
force-pushed
the
doc-test-attr-check
branch
from
4400ec0
to
55cec90
Compare
GuillaumeGomez
changed the title
#![doc(test(...))] on items other than the crate root#![doc(test(...))] on items other than the crate root and use future incompatible lint
|
I updated the PR, its description and the title. Don't hesitate to tell me if it could be worded better! |
Manishearth
approved these changes
Mar 4, 2021
|
@bors r+ |
|
📌 Commit 55cec90 has been approved by |
bors
added
S-waiting-on-bors
ollie27
reviewed
Mar 5, 2021
| /// Previously, there were very like checks being performed on `#[doc(..)]` | ||
| /// unlike the other attributes. It'll now catch all the issues that it | ||
| /// silently ignored previously. | ||
| pub INVALID_DOC_ATTRIBUTE, |
There was a problem hiding this comment.
Lint names should be plural: https://github.com/rust-lang/rfcs/blob/master/text/0344-conventions-galore.md#lints
|
@bors r- yep, good catch, thanks |
bors
added
S-waiting-on-author
|
Fixed the lint name! |
|
@bors r+ |
|
📌 Commit a11e87e has been approved by |
bors
added
S-waiting-on-bors
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Mar 5, 2021
… r=Manishearth Warn on `#![doc(test(...))]` on items other than the crate root and use future incompatible lint Part of rust-lang#82672. This PR does multiple things: * Create a new `INVALID_DOC_ATTRIBUTE` lint which is also "future incompatible", allowing us to use it as a warning for the moment until it turns (eventually) into a hard error. * Use this link when `#![doc(test(...))]` isn't used at the crate level. * Make rust-lang#82702 use this new lint as well. r? `@jyn514`
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 5, 2021
…laumeGomez Rollup of 7 pull requests Successful merges: - rust-lang#80845 (Make ItemKind::ExternCrate looks like hir::ItemKind::ExternCrate to make transition over hir::ItemKind simpler) - rust-lang#82708 (Warn on `#![doc(test(...))]` on items other than the crate root and use future incompatible lint) - rust-lang#82714 (Detect match arm body without braces) - rust-lang#82736 (Bump optimization from mir_opt_level 2 to 3 and 3 to 4 and make "release" be level 2 by default) - rust-lang#82782 (Make rustc shim's verbose output include crate_name being compiled.) - rust-lang#82797 (Update tests names to start with `issue-`) - rust-lang#82809 (rustdoc: Use substrings instead of split to grab enum variant paths) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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.
Part of #82672.
This PR does multiple things:
INVALID_DOC_ATTRIBUTElint which is also "future incompatible", allowing us to use it as a warning for the moment until it turns (eventually) into a hard error.#![doc(test(...))]isn't used at the crate level.r? @jyn514