Fix documentation on onion message packet ControlTlvs
authorValentine Wallace <vwallace@protonmail.com>
Wed, 9 Aug 2023 21:29:35 +0000 (14:29 -0700)
committerValentine Wallace <vwallace@protonmail.com>
Wed, 23 Aug 2023 15:28:42 +0000 (11:28 -0400)
lightning/src/onion_message/packet.rs

index 9eb2e21c2657d944d6d591c9c6f542f49df6ce4f..a76371b39eb9fa12769e2144fb6cdd02067b70f7 100644 (file)
@@ -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),