From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Thu, 18 Jul 2024 22:53:39 +0000 (-0500)
Subject: Add docs to Metadata::without_keys
X-Git-Tag: v0.0.124-beta~37^2~13
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=f537abd960d83f39bf4b1a66e76560136d8be199;p=rust-lightning

Add docs to Metadata::without_keys
---

diff --git a/lightning/src/offers/signer.rs b/lightning/src/offers/signer.rs
index e161a7237..ca78bc422 100644
--- a/lightning/src/offers/signer.rs
+++ b/lightning/src/offers/signer.rs
@@ -106,6 +106,11 @@ impl Metadata {
 		}
 	}
 
+	/// Indicates that signing keys should not be derived when calling [`derive_from`]. Only
+	/// applicable to state [`Metadata::DerivedSigningPubkey`]; calling this in other states will
+	/// result in no change.
+	///
+	/// [`derive_from`]: Self::derive_from
 	pub fn without_keys(self) -> Self {
 		match self {
 			Metadata::Bytes(_) => self,