Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Commit 56ea9e3

Browse files
committed
doc: add missing docs for MultiaddrWithPeerId struct fields
1 parent 2ba7090 commit 56ea9e3

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

src/p2p/addr.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,9 @@ impl FromStr for MultiaddrWithoutPeerId {
8282
/// don't support it being contained within the `Multiaddr`.
8383
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
8484
pub struct MultiaddrWithPeerId {
85+
/// The peer without its address.
8586
pub multiaddr: MultiaddrWithoutPeerId,
87+
/// The address of the peer.
8688
pub peer_id: PeerId,
8789
}
8890

src/path.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ impl IpfsPath {
8383
}
8484
}
8585

86-
/// Returns the [`PathRoot`] "protocol" configured for the [`IpfsPath`].
86+
/// Returns the [`PathRoot`] "protocol" configured for the [`IpfsPath`].
8787
pub fn root(&self) -> &PathRoot {
8888
&self.root
8989
}

0 commit comments

Comments
 (0)