What the developer wrote
Authored by Tobin C. Harding
units: Fix fee_rate docs
Users get unit using the `to_sat_per` family of functions not
`from_sat`.
What changed, and why it matters
This is a one-word documentation fix in a Rust Bitcoin library comment. It corrects a typo in the user-facing documentation for the FeeRate type, changing 'from_sat_per*' to 'to_sat_per*' so the described function names match the actual API. There is no code change and no security impact.
No security action needed. Treat as a normal documentation correction.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit modifies a doc comment in units/src/fee_rate/mod.rs. The comment previously told users to extract fee-rate values using ‘from_sat_per’ functions, but the actual methods are named ‘to_sat_per’. The patch changes only that word. No executable code, type signatures, logic, or public API surface is altered.
Changed components
units/src/fee_rate/mod.rs documentation commentInspect captured patch +1 / −1
diff --git a/units/src/fee_rate/mod.rs b/units/src/fee_rate/mod.rs
index 5ea3cc74..0b0b5cd5 100644
--- a/units/src/fee_rate/mod.rs
+++ b/units/src/fee_rate/mod.rs
@@ -23,7 +23,7 @@ mod encapsulate {
///
/// NOTE: `FeeRate` explicitly does not have any format/display trait implementations, as it
/// doesn't have a standard unit for measure. Users are expected to format it on their own by
- /// extracting values in desired units with `from_sat_per*` functions.
+ /// extracting values in desired units with `to_sat_per*` functions.
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct FeeRate(u64);
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.