fixup! docs

Author: devrandom

lightning/src/ln/chan_utils.rs

@@ -591,7 +591,15 @@ impl_writeable!(ChannelTransactionParameters, 0, {
 	is_outbound_from_holder
 });
 
-/// Static channel fields used to build transactions given per-commitment fields (CommitmentTransaction)
+/// Static channel fields used to build transactions given per-commitment fields (CommitmentTransaction).
+///
+/// If holder is the broadcaster, we map structure elements
+/// (holder_pubkeys, counterparty_pubkeys, counterparty_selected_contest_delay) to
+/// (broadcaster_pubkeys, countersignatory_pubkeys, contest_delay).  If the counterparty is the
+/// broadcaster, the parties are swapped in the above mapping.
+///
+/// This structure makes transaction fields (as consumed by CommitmentTransaction) independent of
+/// transaction ownership.
 pub struct DirectedChannelTransactionParameters<'a> {
 	/// The holder's channel static info
 	info: &'a ChannelTransactionParameters,
@@ -615,7 +623,10 @@ impl<'a> DirectedChannelTransactionParameters<'a> {
 		if self.broadcaster_is_holder { self.info.counterparty_selected_contest_delay } else { self.info.holder_selected_contest_delay }
 	}
 
-	/// Whether the channel is outbound from the broadcaster
+	/// Whether the channel is outbound from the broadcaster.
+	///
+	/// The boolean representing the side that initiated the channel is
+	/// an input to the commitment number obscure factor computation.
 	pub fn is_outbound(&self) -> bool {
 		return if self.broadcaster_is_holder { self.info.is_outbound_from_holder } else { !self.info.is_outbound_from_holder };
 	}