Skip to content

Commit

Permalink
Fix documentation on onion message packet ControlTlvs
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinewallace committed Aug 18, 2023
1 parent 35fc5e1 commit 3b75164
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lightning/src/onion_message/packet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,9 @@ ReadableArgs<(SharedSecret, &H, &L)> for Payload<<H as CustomOnionMessageHandler
}

/// When reading a packet off the wire, we don't know a priori whether the packet is to be forwarded
/// or received. Thus we read a ControlTlvs rather than reading a ForwardControlTlvs or
/// ReceiveControlTlvs directly. Also useful on the encoding side to keep forward and receive TLVs
/// in the same iterator.
/// or received. Thus we read a `ControlTlvs` rather than reading a [`ForwardTlvs`] or
/// [`ReceiveTlvs`] directly. Also useful on the encoding side to keep forward and receive TLVs in
/// the same iterator.
pub(crate) enum ControlTlvs {
/// This onion message is intended to be forwarded.
Forward(ForwardTlvs),
Expand Down

0 comments on commit 3b75164

Please sign in to comment.