improve docs

This commit is contained in:
Aarsh Shah 2020-02-14 16:41:53 +05:30
parent 614f0df686
commit 6eb7467aec

View File

@ -91,6 +91,7 @@ type AddrBook interface {
// evicted till `Unpin` has explicitly been called for the peer.
// However, a caller can still evict the addresses by calling `ClearAddrs`.
// This does not mutate the TTL, only prevents evicting addresses even if the TTL has expired.
// Calling `PinAddr` for a peer that does not exist in the peerstore is a no-op.
PinAddr(p peer.ID)
// UnpinAddr undoes the `Pin` operation for the peer.