f fix comments

Author: andozw

lightning/src/ln/channelmanager.rs

@@ -2477,7 +2477,7 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 	/// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
 	/// different route unless you intend to pay twice!
 	///
-	/// Provide recipient_info to include payment_secret or payment_metadata), note that the 
+	/// Provide recipient_info to include payment_secret or payment_metadata, note that the
 	/// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
 	/// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
 	/// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route

lightning/src/ln/mod.rs

@@ -86,12 +86,13 @@ pub struct PaymentPreimage(pub [u8;32]);
 /// (C-not exported) as we just use [u8; 32] directly
 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
 pub struct PaymentSecret(pub [u8;32]);
-/// recipient-info type, use to provide payment_secret or bolt11 payment_metadata
+/// Additional BOLT 11 data to attach to the payment, useful for applications where the recipient
+/// doesn't keep any context for the payment.
 #[derive(Clone, Debug, PartialEq)]
 pub struct RecipientInfo {
-	/// optional payment_secret
+	/// Optional payment secret provided by the recipient as part of a BOLT 11 invoice.
 	pub payment_secret: Option<PaymentSecret>,
-	/// optional bolt11 payment_metadata
+	/// Optional arbitrary data provided by the recipient as part of a BOLT 11 invoice.
 	pub payment_metadata: Option<Vec<u8>>,
 }
 

lightning/src/util/events.rs

@@ -60,7 +60,8 @@ pub enum PaymentPurpose {
 		/// [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
 		/// [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
 		payment_secret: PaymentSecret,
-		///XXX
+		/// Additional metadata to attach to the payment. This supports applications where the recipient doesn't keep any context for the payment.
+		/// Note that the size of this field is limited by the maximum hop payload size. Long metadata fields reduce the maximum route length.
 		payment_metadata: Option<Vec<u8>>,
 	},
 	/// Because this is a spontaneous payment, the payer generated their own preimage rather than us