chore: add and fix more lints, improve docs #4765
Conversation
DaniPopes
force-pushed
the
dani/better-docs
branch
from
5f52818
to
9e47873
Compare
Codecov Report
... and 4 files with indirect coverage changes
Flags with carried forward coverage won't be shown. Click here to find out more.
|
onbjerg
added
the
C-debt
| @@ -1037,6 +1039,7 @@ pub(crate) enum PeerCommand { | |||
|
|
|||
| /// Actions the peer manager can trigger. | |||
| #[derive(Debug)] | |||
| #[allow(missing_docs)] | |||
There was a problem hiding this comment.
this allow is not needed i think?
There was a problem hiding this comment.
can also be resolved by adding a simple one liner to PeerRemoved
There was a problem hiding this comment.
struct-like variants' fields need docs (c in enum A { B { c: ... } })
There was a problem hiding this comment.
BTW this whole module/crate is weird, I would appreciate someone taking a look after this PR with unreachable_pub because a lot of the public structs reference private ones in docs and I don't know which should be public or not
| @@ -1037,6 +1039,7 @@ pub(crate) enum PeerCommand { | |||
|
|
|||
| /// Actions the peer manager can trigger. | |||
| #[derive(Debug)] | |||
| #[allow(missing_docs)] | |||
There was a problem hiding this comment.
can also be resolved by adding a simple one liner to PeerRemoved
See commits, just boring changes:
rustdoc::all--generate-link-to-definition,--show-type-layout, and#![feature(doc_cfg, doc_auto_cfg)]unstable features to rustdoc builds for better documentation