Skip to content

Commit

Permalink
docs(swarm): fix stale docs around confirmed addresses
Browse files Browse the repository at this point in the history
Discovered in #3954 (review).

Pull-Request: #4135.
  • Loading branch information
thomaseizinger authored Jul 1, 2023
1 parent 7eeb144 commit 68e6bf9
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions swarm/src/behaviour.rs
Original file line number Diff line number Diff line change
Expand Up @@ -443,7 +443,7 @@ pub enum FromSwarm<'a, Handler> {
ListenerClosed(ListenerClosed<'a>),
/// Informs the behaviour that we have discovered a new candidate for an external address for us.
NewExternalAddrCandidate(NewExternalAddrCandidate<'a>),
/// Informs the behaviour that an external address of the local node was removed.
/// Informs the behaviour that an external address of the local node was confirmed.
ExternalAddrConfirmed(ExternalAddrConfirmed<'a>),
/// Informs the behaviour that an external address of the local node expired, i.e. is no-longer confirmed.
ExternalAddrExpired(ExternalAddrExpired<'a>),
Expand Down Expand Up @@ -541,14 +541,13 @@ pub struct ListenerClosed<'a> {
pub reason: Result<(), &'a std::io::Error>,
}

/// [`FromSwarm`] variant that informs the behaviour
/// that we have discovered a new candidate for an external address for us.
/// [`FromSwarm`] variant that informs the behaviour about a new candidate for an external address for us.
#[derive(Clone, Copy)]
pub struct NewExternalAddrCandidate<'a> {
pub addr: &'a Multiaddr,
}

/// [`FromSwarm`] variant that informs the behaviour that an external address was removed.
/// [`FromSwarm`] variant that informs the behaviour that an external address was confirmed.
#[derive(Clone, Copy)]
pub struct ExternalAddrConfirmed<'a> {
pub addr: &'a Multiaddr,
Expand Down

0 comments on commit 68e6bf9

Please sign in to comment.