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

Commit d5f4c72

Browse files
committed
doc: correct Swarm docs
1 parent 23fda6e commit d5f4c72

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/p2p/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ mod transport;
1717
pub use addr::{MultiaddrWithPeerId, MultiaddrWithoutPeerId};
1818
pub use {behaviour::KadResult, swarm::Connection};
1919

20-
/// An IPFS swarm.
20+
/// Type alias for [`libp2p::Swarm`] running the [`behaviour::Behaviour`] with the given [`IpfsTypes`].
2121
pub type TSwarm<T> = Swarm<behaviour::Behaviour<T>>;
2222

2323
/// Defines the configuration for an IPFS swarm.
@@ -30,7 +30,7 @@ pub struct SwarmOptions {
3030
pub bootstrap: Vec<(Multiaddr, PeerId)>,
3131
/// Enables mdns for peer discovery and announcement when true.
3232
pub mdns: bool,
33-
/// Custom Kademlia protocol name.
33+
/// Custom Kademlia protocol name, see [`IpfsOptions::kad_protocol`].
3434
pub kad_protocol: Option<String>,
3535
}
3636

0 commit comments

Comments
 (0)