Add allow(clippy::missing_docs_in_private_items)

[daxpedda]

Apparently clippy::missing_docs_in_private_items triggers in proc-macros, seeing that pin-project already adds a sizable amount of #[allow(...)]s I thought a PR might not hurt.

I also submitted an issue at Clippy: rust-lang/rust-clippy#12197.

[taiki-e]

Thanks! Could you add a case that triggers this to tests/lint.rs test?

[daxpedda]

The lint apparently doesn't trigger in tests, so I can't add it in tests/lint.rs.
I tried adding it in a unit test, but that doesn't work either because the proc-macro can't find pin_project as a dependency.
Also tried to add pin_project as a dev-dependency, but that still requires me to put it behind a #[cfg(test)] guard, which again disables the lint.

In the meantime I found that empty enum variants can still trigger this lint, so I had to add another #[allow(...)].

Here is some code that can trigger both cases:

//! Testing `clippy::missing_docs_in_private_items`.

#![warn(clippy::missing_docs_in_private_items)]

use pin_project::pin_project;

#[pin_project(project_replace)]
pub struct Test1 {
    pub test: u8, // Triggered here.
}

#[pin_project(project = Test2Proj)]
pub enum Test2 {
    VariantA(u8),
    VariantB, // Triggered here.
}

[daxpedda]

I guess one last idea to get this lint tested would be to make a sub-crate only for lint testing, so it's not behind a #[cfg(test)].
Could potentially also move the whole of tests/lint.rs there?

[taiki-e]

I guess one last idea to get this lint tested would be to make a sub-crate only for lint testing, so it's not behind a #[cfg(test)].
Could potentially also move the whole of tests/lint.rs there?

I think this (convert the tests/lint.rs to a new test crate) is a reasonable idea. We already have such test crates to check compatibility with no-std/old edition.

• https://github.com/taiki-e/pin-project/tree/main/tests/no-std
• https://github.com/taiki-e/pin-project/tree/main/tests/rust-2015

[daxpedda]

Done.
This also uncovered two more cases of FP that I addressed as well.

[taiki-e]

Thanks!

[taiki-e]

Published in 1.1.4.