Improve docs on is_implied_by
The lock time methods are a source of endless confusion; make an attempt at improving further the documentation on the two `is_implied_by` methods (one on absolute lock time and one on relative).
This commit is contained in:
parent
b8721bf244
commit
8aa94bd0b2
|
@ -316,7 +316,8 @@ impl LockTime {
|
|||
/// mathematical sense) the smaller one being satisfied.
|
||||
///
|
||||
/// This function is useful if you wish to check a lock time against various other locks e.g.,
|
||||
/// filtering out locks which cannot be satisfied.
|
||||
/// filtering out locks which cannot be satisfied. Can also be used to remove the smaller value
|
||||
/// of two `OP_CHECKLOCKTIMEVERIFY` operations within one branch of the script.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
|
|
|
@ -65,10 +65,17 @@ impl LockTime {
|
|||
/// Returns true if satisfaction of `other` lock time implies satisfaction of this
|
||||
/// [`relative::LockTime`].
|
||||
///
|
||||
/// A lock time can only be satisfied by n blocks being mined or n seconds passing. If you have
|
||||
/// two lock times (same unit) then the larger lock time being satisfied implies (in a
|
||||
/// mathematical sense) the smaller one being satisfied.
|
||||
///
|
||||
/// This function is useful when checking sequence values against a lock, first one checks the
|
||||
/// sequence represents a relative lock time by converting to `LockTime` then use this function
|
||||
/// to see if satisfaction of the newly created lock time would imply satisfaction of `self`.
|
||||
///
|
||||
/// Can also be used to remove the smaller value of two `OP_CHECKSEQUENCEVERIFY` operations
|
||||
/// within one branch of the script.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```rust
|
||||
|
|
Loading…
Reference in New Issue