Add documentation to NumberedCommitmentSigned type alias

p2pderivatives · Dec 20, 2023 · 35c7274 · 35c7274
1 parent f109bee
commit 35c7274
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/lightning/src/ln/channelmanager.rs b/lightning/src/ln/channelmanager.rs
@@ -82,6 +82,8 @@ pub use crate::ln::outbound_payment::{PaymentSendFailure, ProbeSendFailure, Retr
 use crate::ln::script::ShutdownScript;
 use super::msgs::{CommitmentSigned, RevokeAndACK};
 
+/// A tuple containing a [`CommitmentSigned`] message and the commitment transaction number it
+/// corresponds to.
 pub type NumberedCommitmentSigned = (CommitmentSigned, u64);
 
 // We hold various information about HTLC relay in the HTLC objects in Channel itself: