mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 23:08:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Clarify Retry::Timeout vs PaymentParams::expiry_time in docs

Browse source
This commit is contained in:
Valentine Wallace 2023-02-23 15:49:44 -05:00
parent 12bcc9ae43
commit a6e9123d3f
No known key found for this signature in database
GPG key ID: FD3E106A2CE099B4
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lightning/src/ln/outbound_payment.rs
View file

@ -235,7 +235,10 @@ pub enum Retry {
/// were retried along a route from a single call to [`Router::find_route`].
Attempts(usize),
#[cfg(not(feature = "no-std"))]
/// Time elapsed before abandoning retries for a payment.
/// Time elapsed before abandoning retries for a payment. At least one attempt at payment is made;
/// see [`PaymentParameters::expiry_time`] to avoid any attempt at payment after a specific time.
///
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
Timeout(core::time::Duration),
}