From 9b2fc021b21c44828e362b99fedf5654b2eeb785 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Mon, 26 May 2025 14:49:58 +1000 Subject: [PATCH] Improve rustdocs on FeeRate Remove the unit from associated consts and then make all the rustdocs on the various consts use 'The'. --- units/src/fee_rate/mod.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/units/src/fee_rate/mod.rs b/units/src/fee_rate/mod.rs index ceaf239f4..c2ee6f4b9 100644 --- a/units/src/fee_rate/mod.rs +++ b/units/src/fee_rate/mod.rs @@ -31,25 +31,25 @@ mod encapsulate { pub use encapsulate::FeeRate; impl FeeRate { - /// 0 sat/kwu. + /// The zero fee rate. /// /// Equivalent to [`MIN`](Self::MIN), may better express intent in some contexts. 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. pub const MIN: FeeRate = FeeRate::ZERO; - /// Maximum possible value. + /// The maximum possible value. 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. 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); /// Constructs a new [`FeeRate`] from satoshis per 1000 weight units.