Skip to content

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

Merged
bors merged 3 commits intorust-lang:masterfrom
ogoffart:missing-docs-test
Sep 11, 2024
Merged

Fix false positive with missing_docs and #[test]#130219
bors merged 3 commits intorust-lang:masterfrom
ogoffart:missing-docs-test

Conversation

@ogoffart
Copy link
Contributor

@ogoffart ogoffart commented Sep 11, 2024 •
edited
Loading

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 •
edited
Loading

Fixes #130216

@ogoffart ogoffart mentioned this pull request Sep 11, 2024
Closed
@ChrisDenton ChrisDenton linked an issue Sep 11, 2024 that may be closed by this pull request
missing-docs lint reports on #[test] macro #130216
Closed
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@ogoffart
Fix false positive with missing_docs and #[test]
6eddbb7 
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 •
edited
Loading

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
@ogoffart
Use doc(hidden) instead of allow(missing_docs) in the test harness
cc34d64 
So that it doesn't fail with `forbid(missing_docs)`

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

ogoffart 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.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

ogoffart commented Sep 11, 2024

@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
cargo test breaking with forbid(missing_docs) #130218
Closed
workingjubilee added a commit to workingjubilee/rustc that referenced this pull request Sep 11, 2024
@workingjubilee
Rollup merge of rust-lang#130219 - ogoffart:missing-docs-test, r=Urgau
0b4c281 
Fix false positive with `missing_docs` and `#[test]`

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() {}
  | ^^^^^^^^^^^^^^^^^^^
```
@workingjubilee workingjubilee mentioned this pull request Sep 11, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 11, 2024
@bors
Auto merge of rust-lang#130230 - workingjubilee:rollup-0e4ulat, r=wor…
17527ef 
…kingjubilee

Rollup of 14 pull requests

Successful merges:

 - rust-lang#129260 (Don't suggest adding return type for closures with default return type)
 - rust-lang#129520 (Suggest the correct pattern syntax on usage of unit variant pattern for a struct variant)
 - rust-lang#129696 (update stdarch)
 - rust-lang#129759 (Stabilize `const_refs_to_static`)
 - rust-lang#129835 (enable const-float-classify test, and test_next_up/down on 32bit x86)
 - rust-lang#129866 (Clarify documentation labelling and definitions for std::collections)
 - rust-lang#130052 (Don't leave debug locations for constants sitting on the builder indefinitely)
 - rust-lang#130077 (Fix linking error when compiling for 32-bit watchOS)
 - rust-lang#130123 (Report the `note` when specified in `diagnostic::on_unimplemented`)
 - rust-lang#130156 (Add test for S_OBJNAME & update test for LF_BUILDINFO cl and cmd)
 - rust-lang#130206 (Map `WSAEDQUOT` to `ErrorKind::FilesystemQuotaExceeded`)
 - rust-lang#130207 (Map `ERROR_CANT_RESOLVE_FILENAME` to `ErrorKind::FilesystemLoop`)
 - rust-lang#130219 (Fix false positive with `missing_docs` and `#[test]`)
 - rust-lang#130221 (Make SearchPath::new public)

r? `@ghost`
`@rustbot` modify labels: rollup
@matthiaskrgr matthiaskrgr mentioned this pull request Sep 11, 2024
Merged
@Urgau Urgau mentioned this pull request Sep 11, 2024
Closed
@duncanpharvey duncanpharvey mentioned this pull request Sep 11, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 11, 2024
@bors
Auto merge of rust-lang#130237 - matthiaskrgr:rollup-qmgr8i7, r=matth…
8d6b88b 
…iaskrgr

Rollup of 9 pull requests

Successful merges:

 - rust-lang#129260 (Don't suggest adding return type for closures with default return type)
 - rust-lang#129520 (Suggest the correct pattern syntax on usage of unit variant pattern for a struct variant)
 - rust-lang#129866 (Clarify documentation labelling and definitions for std::collections)
 - rust-lang#130123 (Report the `note` when specified in `diagnostic::on_unimplemented`)
 - rust-lang#130161 (refactor merge base logic and fix `x fmt`)
 - rust-lang#130206 (Map `WSAEDQUOT` to `ErrorKind::FilesystemQuotaExceeded`)
 - rust-lang#130207 (Map `ERROR_CANT_RESOLVE_FILENAME` to `ErrorKind::FilesystemLoop`)
 - rust-lang#130219 (Fix false positive with `missing_docs` and `#[test]`)
 - rust-lang#130221 (Make SearchPath::new public)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 66727ea into rust-lang:master Sep 11, 2024
@rustbot rustbot added this to the 1.83.0 milestone Sep 11, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Sep 11, 2024
@rust-timer
Unrolled build for rust-lang#130219
822feee 
Rollup merge of rust-lang#130219 - ogoffart:missing-docs-test, r=Urgau

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

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() {}
  | ^^^^^^^^^^^^^^^^^^^
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@Urgau Urgau

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

Milestone

1.83.0

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

@ogoffart @rustbot @rust-log-analyzer @Urgau @bors @cjgillot