milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Improve rustdocs on FeeRate 

Remove the unit from associated consts and then make all the rustdocs on
the various consts use 'The'.
This commit is contained in:
Tobin C. Harding 2025-05-26 14:49:58 +10:00
parent 1bd1e89458
commit 9b2fc021b2
No known key found for this signature in database
GPG Key ID: 0AEF0A899E41F7DD
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
units/src/fee_rate/mod.rs
View File

@ -31,25 +31,25 @@ mod encapsulate {
pub use encapsulate::FeeRate; pub use encapsulate::FeeRate;
impl FeeRate { impl FeeRate {
/// 0 sat/kwu. /// The zero fee rate.
/// ///
/// Equivalent to [`MIN`](Self::MIN), may better express intent in some contexts. /// Equivalent to [`MIN`](Self::MIN), may better express intent in some contexts.
pub const ZERO: FeeRate = FeeRate::from_sat_per_mvb(0); pub const ZERO: FeeRate = FeeRate::from_sat_per_mvb(0);
/// Minimum possible value (0 sat/kwu). /// The minimum possible value.
/// ///
/// Equivalent to [`ZERO`](Self::ZERO), may better express intent in some contexts. /// Equivalent to [`ZERO`](Self::ZERO), may better express intent in some contexts.
pub const MIN: FeeRate = FeeRate::ZERO; pub const MIN: FeeRate = FeeRate::ZERO;
/// Maximum possible value. /// The maximum possible value.
pub const MAX: FeeRate = FeeRate::from_sat_per_mvb(u64::MAX); pub const MAX: FeeRate = FeeRate::from_sat_per_mvb(u64::MAX);
/// Minimum fee rate required to broadcast a transaction. /// The minimum fee rate required to broadcast a transaction.
/// ///
/// The value matches the default Bitcoin Core policy at the time of library release. /// The value matches the default Bitcoin Core policy at the time of library release.
pub const BROADCAST_MIN: FeeRate = FeeRate::from_sat_per_vb_u32(1); pub const BROADCAST_MIN: FeeRate = FeeRate::from_sat_per_vb_u32(1);
/// Fee rate used to compute dust amount. /// The fee rate used to compute dust amount.
pub const DUST: FeeRate = FeeRate::from_sat_per_vb_u32(3); pub const DUST: FeeRate = FeeRate::from_sat_per_vb_u32(3);
/// Constructs a new [`FeeRate`] from satoshis per 1000 weight units. /// Constructs a new [`FeeRate`] from satoshis per 1000 weight units.