From: Valentine Wallace <vwallace@protonmail.com>
Date: Fri, 6 Aug 2021 22:17:58 +0000 (-0400)
Subject: Update keysend docs
X-Git-Tag: v0.0.100~6^2~1
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=929259e54621c348dcacc09a8439f7ceae3c67cb;p=rust-lightning

Update keysend docs
---

diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
index 24c0c688c..67ca27fb8 100644
--- a/lightning/src/ln/channelmanager.rs
+++ b/lightning/src/ln/channelmanager.rs
@@ -1912,9 +1912,13 @@ impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelMana
 	/// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
 	/// never reach the recipient.
 	///
+	/// See [`send_payment`] documentation for more details on the return value of this function.
+	///
 	/// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
 	/// [`send_payment`] for more information about the risks of duplicate preimage usage.
 	///
+	/// Note that `route` must have exactly one path.
+	///
 	/// [`send_payment`]: Self::send_payment
 	pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<PaymentHash, PaymentSendFailure> {
 		let preimage = match payment_preimage {