Skip to content

Commit 23fc495

Browse files
committed
f queue docs
1 parent de1570c commit 23fc495

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lightning/src/ln/channel.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1947,8 +1947,9 @@ impl<Signer: Sign> Channel<Signer> {
19471947
/// however, fail more than once as we wait for an upstream failure to be irrevocably committed
19481948
/// before we fail backwards.
19491949
///
1950-
/// If we do fail twice, we debug_assert!(false) and return Ok(()). Thus, will always return
1951-
/// Ok(()) if preconditions are met.
1950+
/// If we do fail twice, we `debug_assert!(false)` and return `Ok(None)`. Thus, this will always
1951+
/// return `Ok(_)` if preconditions are met. In any case, `Err`s will only be
1952+
/// [`ChannelError::Ignore`].
19521953
pub fn queue_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L)
19531954
-> Result<(), ChannelError> where L::Target: Logger {
19541955
self.fail_htlc(htlc_id_arg, err_packet, true, logger)

0 commit comments

Comments
 (0)