From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Tue, 9 Jul 2024 18:31:34 +0000 (-0500)
Subject: Clean up MessageContext docs
X-Git-Tag: v0.0.124-beta~37^2~22
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=c58a1bbaa58618af9b27078b60ca409d69e1e42f;p=rust-lightning

Clean up MessageContext docs
---

diff --git a/lightning/src/blinded_path/message.rs b/lightning/src/blinded_path/message.rs
index fe1a8b766..08e556a9c 100644
--- a/lightning/src/blinded_path/message.rs
+++ b/lightning/src/blinded_path/message.rs
@@ -85,20 +85,20 @@ impl Writeable for ReceiveTlvs {
 	}
 }
 
-/// Represents additional data included by the recipient in a [`BlindedPath`].
+/// Additional data included by the recipient in a [`BlindedPath`].
 ///
-/// This data is encrypted by the recipient and remains invisible to anyone else.
-/// It is included in the [`BlindedPath`], making it accessible again to the recipient
-/// whenever the [`BlindedPath`] is used.
-/// The recipient can authenticate the message and utilize it for further processing
-/// if needed.
+/// This data is encrypted by the recipient and will be given to the corresponding message handler
+/// when handling a message sent over the [`BlindedPath`]. The recipient can use this data to
+/// authenticate the message or for further processing if needed.
 #[derive(Clone, Debug)]
 pub enum MessageContext {
-	/// Represents the data specific to [`OffersMessage`]
+	/// Context specific to an [`OffersMessage`].
 	///
 	/// [`OffersMessage`]: crate::onion_message::offers::OffersMessage
 	Offers(OffersContext),
-	/// Represents custom data received in a Custom Onion Message.
+	/// Context specific to a [`CustomOnionMessageHandler::CustomMessage`].
+	///
+	/// [`CustomOnionMessageHandler::CustomMessage`]: crate::onion_message::messenger::CustomOnionMessageHandler::CustomMessage
 	Custom(Vec<u8>),
 }