From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Thu, 19 Oct 2023 21:36:02 +0000 (-0500)
Subject: Expand request_refund_payment docs for limitations
X-Git-Tag: v0.0.118~6^2~2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=6d2ffdd8bd5967eb26962119c53e383914eda9b2;p=rust-lightning

Expand request_refund_payment docs for limitations
---

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index e71d7124a..6ed423379 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -7528,7 +7528,9 @@ where
 	/// # Limitations
 	///
 	/// Requires a direct connection to an introduction node in [`Refund::paths`] or to
-	/// [`Refund::payer_id`], if empty.
+	/// [`Refund::payer_id`], if empty. This request is best effort; an invoice will be sent to each
+	/// node meeting the aforementioned criteria, but there's no guarantee that they will be
+	/// received and no retries will be made.
 	///
 	/// [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 	pub fn request_refund_payment(&self, refund: &Refund) -> Result<(), Bolt12SemanticError> {