Clean up FundedChannel::pending_splice docs
What the developer wrote
Authored by Jeffrey Czyz
Clean up FundedChannel::pending_splice docs
What changed, and why it matters
This commit only changes a documentation comment for an internal field. It rewords the description of what the pending_splice field tracks. No code behavior is modified, so there is no security impact.
No action needed; this is a non-functional documentation cleanup.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff updates a single Rust doc comment on FundedChannel::pending_splice from ‘Info about an in-progress, pending splice (if any), on the pre-splice channel’ to ‘Information about any pending splice candidates, including RBF attempts.’ No executable code, types, visibility, or logic are altered.
Changed components
lightning/src/ln/channel.rs documentation comment onlyInspect captured patch +2 / −1
diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 893efe7..ec7824b 100644
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -6671,7 +6671,8 @@ where
/// This field is cleared once our counterparty sends a `channel_ready`.
pub interactive_tx_signing_session: Option<InteractiveTxSigningSession>,
holder_commitment_point: HolderCommitmentPoint,
- /// Info about an in-progress, pending splice (if any), on the pre-splice channel
+
+ /// Information about any pending splice candidates, including RBF attempts.
pending_splice: Option<PendingFunding>,
/// Once we become quiescent, if we're the initiator, there's some action we'll want to take.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.