LukasKalbertodt / confique

Type-safe, layered, light-weight, `serde`-based configuration library
https://docs.rs/confique
Apache License 2.0
169 stars 10 forks source link

Warning about missing docs (in private items) #33

Closed scullionw closed 2 weeks ago

scullionw commented 1 year ago

same as https://github.com/LukasKalbertodt/confique/issues/25

but for #![deny(clippy::missing_docs_in_private_items)]

To reproduce:

  1. Have a config struct that the lib does not make public
  2. Use #![deny(clippy::missing_docs_in_private_items)]
Screenshot 2023-08-29 at 10 00 12 AM

Seems like the doc comment is not passed through in this case?

LukasKalbertodt commented 1 year ago

And I assume you can't simply annotate your struct with #[allow(clippy::missing_docs_in_private_items)]?

So this crate would have to add said attribute to some items. Now I wonder:

LukasKalbertodt commented 2 weeks ago

I cannot reproduce this. Regardless of whether I make the struct pub or not, as long as the struct itself has docs, no warnings are emitted from the code generated by confique.