From: Valentine Wallace <vwallace@protonmail.com>
Date: Wed, 9 Aug 2023 21:29:35 +0000 (-0700)
Subject: Fix documentation on onion message packet ControlTlvs
X-Git-Tag: v0.0.117-alpha1~45^2~1
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=ebb0676e85f2c335be3213edf1081e0f6a59d777;p=rust-lightning

Fix documentation on onion message packet ControlTlvs
---

diff --git a/lightning/src/onion_message/packet.rs b/lightning/src/onion_message/packet.rs
index 9eb2e21c2..a76371b39 100644
--- a/lightning/src/onion_message/packet.rs
+++ b/lightning/src/onion_message/packet.rs
@@ -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),