search

quinn-rs / quinn

Async-friendly QUIC implementation in Rust
Apache License 2.0
3.76k stars 380 forks source link

Minor doc fixes, document private items on ci #1291

Closed koivunej closed 2 years ago

koivunej commented 2 years ago

Very minor drive-by doc fixes removing the warnings from cargo doc --document-private-links but also enables the #[warn(rustdoc::broken_intra_doc_links)] to catch these earlier. With the additional --document-private-items in workflow the private links are checked as well.

koivunej commented 2 years ago

No strong feelings on the #![deny(rustdoc::broken_intra_doc_links)] nor the workflow change, happy to drop them if they are not wanted.

djc commented 2 years ago

Thanks for working on this!

Can we do -D warn in CI instead of denying at compile time?

koivunej commented 2 years ago

Changed the deny to warn by changing the 4th commit. PR desc updated.

koivunej commented 2 years ago

Can we do -D warn in CI instead of denying at compile time?

Initially misunderstood this and changed the #![deny(rustdoc::...)] to #![warn(rustdoc::...)] but instead you meant to use RUSTDOCFLAGS when doing cargo doc. I had missed that RUSTDOCFLAGS="-Dwarnings" was already being set so the only needed thing was the --document-private-items.