Add additional documentation on `Channel::unbroadcasted_funding`

diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 576ae665ade3d89603304bda117d5ee8a0ba8880..fe01a26290c331e28bd6186408ab14919ab5078b 100644 (file)
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -3457,6 +3457,9 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider  {
 
        /// Returns the transaction if there is a pending funding transaction that is yet to be
        /// broadcast.
+       ///
+       /// Note that if [`Self::is_manual_broadcast`] is true the transaction will be a dummy
+       /// transaction.
        pub fn unbroadcasted_funding(&self) -> Option<Transaction> {
                self.if_unbroadcasted_funding(|| self.funding_transaction.clone())
        }