Skip to content

Commit 68a4026

Browse files
committed
doc(relay-pool): improve RelayStatus variants doc
Signed-off-by: Yuki Kishimoto <[email protected]>
1 parent ecd8391 commit 68a4026

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

crates/nostr-relay-pool/src/relay/status.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,17 @@ impl AtomicRelayStatus {
4848
/// Relay connection status
4949
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
5050
pub enum RelayStatus {
51-
/// Initialized
51+
/// The relay has just been created.
5252
Initialized = 0,
53-
/// Pending
53+
/// The relay will try to connect shortly.
5454
Pending = 1,
55-
/// Connecting
55+
/// Trying to connect.
5656
Connecting = 2,
57-
/// Connected
57+
/// Connected.
5858
Connected = 3,
59-
/// Disconnected, will retry to connect again
59+
/// The connection failed, but another attempt will occur soon.
6060
Disconnected = 4,
61-
/// Completely disconnected
61+
/// The connection has been terminated and no retry will occur.
6262
Terminated = 5,
6363
}
6464

0 commit comments

Comments
 (0)