Skip to content

Fix false positive with missing_docs and #[test] #130219

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

Merged
merged 3 commits into from
Sep 11, 2024

Conversation

ogoffart
Copy link
Contributor

@ogoffart ogoffart commented Sep 11, 2024

Since #130025, the compiler don't ignore missing_docs when compiling the tests. But there is now a false positive warning for every #[test]

For example, this code

//! Crate docs
#![warn(missing_docs)]
#[test]
fn just_a_test() {}

Would emit this warning when running cargo test

warning: missing documentation for a constant
 --> src/lib.rs:5:1
  |
4 | #[test]
  | ------- in this procedural macro expansion
5 | fn just_a_test() {}
  | ^^^^^^^^^^^^^^^^^^^

@rustbot
Copy link
Collaborator

rustbot commented Sep 11, 2024

r? @cjgillot

rustbot has assigned @cjgillot.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Sep 11, 2024
@ogoffart
Copy link
Contributor Author

ogoffart commented Sep 11, 2024

Fixes #130216

@rust-log-analyzer

This comment has been minimized.

Since rust-lang#130025, the compiler don't ignore missing_docs when compiling the tests.
But there is now a false positive warning for every `#[test]`

For example, this code
```rust
//! Crate docs

fn just_a_test() {}
```

Would emit this warning when running `cargo test`

```
warning: missing documentation for a constant
 --> src/lib.rs:5:1
  |
4 | #[test]
  | ------- in this procedural macro expansion
5 | fn just_a_test() {}
  | ^^^^^^^^^^^^^^^^^^^
```
@ogoffart
Copy link
Contributor Author

ogoffart commented Sep 11, 2024

Alternative would be to add #[doc(hidden)] instead for the generated const

Edit: I went for this option.

@Urgau
Copy link
Member

Urgau commented Sep 11, 2024

Could you also change the #[allow(missing_docs)] on the test harness main function to #[doc(hidden)] which should fix #130218 as well, and also change the test to use forbid/-F.

r? @Urgau
@rustbot author

@rustbot rustbot assigned Urgau and unassigned cjgillot Sep 11, 2024
@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 11, 2024
So that it doesn't fail with `forbid(missing_docs)`

Fixes rust-lang#130218
@ogoffart
Copy link
Contributor Author

Could you also change the #[allow(missing_docs)] on the test harness main function to #[doc(hidden)] which should fix #130218 as well, and also change the test to use forbid/-F.Could you also change the #[allow(missing_docs)] on the test harness main function to #[doc(hidden)] which should fix #130218 as well, and also change the test to use forbid/-F.

Done

@ogoffart
Copy link
Contributor Author

@rustbot review

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 11, 2024
@Urgau
Copy link
Member

Urgau commented Sep 11, 2024

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Sep 11, 2024

📌 Commit cc34d64 has been approved by Urgau

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Sep 11, 2024
@Urgau Urgau linked an issue Sep 11, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cargo test breaking with forbid(missing_docs) missing-docs lint reports on #[test] macro
6 participants