mirror of
https://github.com/lightningdevkit/rust-lightning.git
synced 2025-02-25 07:17:40 +01:00
Clarify Retry::Timeout vs PaymentParams::expiry_time in docs
This commit is contained in:
parent
12bcc9ae43
commit
a6e9123d3f
1 changed files with 4 additions and 1 deletions
|
@ -235,7 +235,10 @@ pub enum Retry {
|
||||||
/// were retried along a route from a single call to [`Router::find_route`].
|
/// were retried along a route from a single call to [`Router::find_route`].
|
||||||
Attempts(usize),
|
Attempts(usize),
|
||||||
#[cfg(not(feature = "no-std"))]
|
#[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),
|
Timeout(core::time::Duration),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue