Skip to content

Commit 4cc6682

Browse files
committed
f further doc tweaks
1 parent 5c6751c commit 4cc6682

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

lightning/src/ln/peer_handler.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -179,11 +179,11 @@ pub struct MessageHandler<CM: Deref, RM: Deref> where
179179
/// For efficiency, Clone should be relatively cheap for this type.
180180
///
181181
/// Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
182-
/// has been disconnected, the [`PeerManager`] informed of the disconnection (either by it having
183-
/// triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no further
184-
/// calls to the [`PeerManager`] related to the original socket occur. This allows you to use a
185-
/// file descriptor for your SocketDescriptor directly, however for simplicity you may wish to
186-
/// simply use another value which is guaranteed to be globally unique instead.
182+
/// has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
183+
/// having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
184+
/// further calls to the [`PeerManager`] related to the original socket occur. This allows you to
185+
/// use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
186+
/// to simply use another value which is guaranteed to be globally unique instead.
187187
pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
188188
/// Attempts to send some data from the given slice to the peer.
189189
///
@@ -628,10 +628,10 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<D
628628
///
629629
/// May return an Err to indicate that the connection should be closed.
630630
///
631-
/// May call [`send_data`] on the descriptor passed in (or another provided descriptor) before
631+
/// May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
632632
/// returning. Thus, be very careful with reentrancy issues! The invariants around calling
633633
/// [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
634-
/// ready to call `[write_buffer_space_avail`] again if a write call generated here isnt'
634+
/// ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
635635
/// sufficient!
636636
///
637637
/// [`send_data`]: SocketDescriptor::send_data
@@ -1381,7 +1381,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref> PeerManager<D
13811381
/// It will send pings to each peer and disconnect those which did not respond to the last
13821382
/// round of pings.
13831383
///
1384-
/// May call [`send_data`] all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
1384+
/// May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
13851385
/// issues!
13861386
///
13871387
/// [`send_data`]: SocketDescriptor::send_data

0 commit comments

Comments
 (0)