units: Use uniform docs style for 1000
What the developer wrote
Authored by Tobin C. Harding
units: Use uniform docs style for 1000
We have '1000' and also '1,000' - pick one and be uniform.
Favour using the comma because we already have other usages eg
1,000,000
What changed, and why it matters
This commit only changes two documentation comments in the rust-bitcoin library to use a consistent style for writing the number 1000 (with a comma as '1,000'). It does not modify any executable code, logic, or data handling.
No action needed; this is a non-functional documentation style change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff alters two Rust doc comments in units/src/fee_rate/mod.rs, replacing ‘1000’ with ‘1,000’ for stylistic uniformity. No code, constants, types, or behavior changed.
Changed components
units/src/fee_rate/mod.rs documentation commentsInspect captured patch +2 / −2
diff --git a/units/src/fee_rate/mod.rs b/units/src/fee_rate/mod.rs
index 0b0b5cd5..15c7f0b9 100644
--- a/units/src/fee_rate/mod.rs
+++ b/units/src/fee_rate/mod.rs
@@ -63,14 +63,14 @@ impl FeeRate {
/// The fee rate used to compute dust amount.
pub const DUST: Self = Self::from_sat_per_vb(3);
- /// Constructs a new [`FeeRate`] from satoshis per 1000 weight units.
+ /// Constructs a new [`FeeRate`] from satoshis per 1,000 weight units.
#[inline]
pub const fn from_sat_per_kwu(sat_kwu: u32) -> Self {
let fee_rate = (const_casts::u32_to_u64(sat_kwu)) * 4_000;
Self::from_sat_per_mvb(fee_rate)
}
- /// Constructs a new [`FeeRate`] from amount per 1000 weight units.
+ /// Constructs a new [`FeeRate`] from amount per 1,000 weight units.
#[inline]
pub const fn from_per_kwu(rate: Amount) -> NumOpResult<Self> {
// No `map()` in const context.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.