rust/tests/ui/lint/lint-missing-doc-test.rs

//! This test checks that denying the missing_docs lint does not trigger
//! on the generated test harness.

//@ check-pass
//@ compile-flags: --test

#![forbid(missing_docs)]

#[test]
fn test() {}
Allow `missing_docs` lint on the generated test harness 2024-09-09 06:43:25 -05:00			`//! This test checks that denying the missing_docs lint does not trigger`
			`//! on the generated test harness.`

			`//@ check-pass`
Use `doc(hidden)` instead of `allow(missing_docs)` in the test harness So that it doesn't fail with `forbid(missing_docs)` Fixes #130218 2024-09-11 05:08:14 -05:00			`//@ compile-flags: --test`

			`#![forbid(missing_docs)]`
Fix false positive with `missing_docs` and `#[test]` 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 ```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() {} \| ^^^^^^^^^^^^^^^^^^^ ``` 2024-09-11 03:35:02 -05:00
			`#[test]`
			`fn test() {}`