diff --git a/units/src/amount/error.rs b/units/src/amount/error.rs index 2c91392b4..dd06db041 100644 --- a/units/src/amount/error.rs +++ b/units/src/amount/error.rs @@ -10,7 +10,7 @@ use internals::write_err; use super::INPUT_STRING_LEN_LIMIT; -/// An error during amount parsing amount with denomination. +/// Error returned when parsing an amount with denomination fails. #[derive(Debug, Clone, PartialEq, Eq)] pub struct ParseError(pub(crate) ParseErrorInner); @@ -84,7 +84,7 @@ impl std::error::Error for ParseError { } } -/// An error during amount parsing. +/// Error returned when parsing an amount fails. #[derive(Debug, Clone, PartialEq, Eq)] pub struct ParseAmountError(pub(crate) ParseAmountErrorInner); diff --git a/units/src/fee_rate/mod.rs b/units/src/fee_rate/mod.rs index 0daafa2d2..709e3f988 100644 --- a/units/src/fee_rate/mod.rs +++ b/units/src/fee_rate/mod.rs @@ -10,7 +10,7 @@ use core::{fmt, ops}; #[cfg(feature = "arbitrary")] use arbitrary::{Arbitrary, Unstructured}; -/// Represents fee rate. +/// Fee rate. /// /// This is an integer newtype representing fee rate in `sat/kwu`. It provides protection against /// mixing up the types as well as basic formatting features. diff --git a/units/src/locktime/absolute.rs b/units/src/locktime/absolute.rs index 698516078..153aa0e33 100644 --- a/units/src/locktime/absolute.rs +++ b/units/src/locktime/absolute.rs @@ -256,7 +256,7 @@ pub const fn is_block_height(n: u32) -> bool { n < LOCK_TIME_THRESHOLD } /// Returns true if `n` is a UNIX timestamp i.e., greater than or equal to 500,000,000. pub const fn is_block_time(n: u32) -> bool { n >= LOCK_TIME_THRESHOLD } -/// An error that occurs when converting a `u32` to a lock time variant. +/// Error returned when converting a `u32` to a lock time variant fails. #[derive(Debug, Clone, PartialEq, Eq)] #[non_exhaustive] pub struct ConversionError { diff --git a/units/src/locktime/relative.rs b/units/src/locktime/relative.rs index 7f8b4413a..9b1abadf7 100644 --- a/units/src/locktime/relative.rs +++ b/units/src/locktime/relative.rs @@ -128,7 +128,7 @@ impl fmt::Display for Time { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fmt::Display::fmt(&self.0, f) } } -/// Input time in seconds was too large to be encoded to a 16 bit 512 second interval. +/// Error returned when the input time in seconds was too large to be encoded to a 16 bit 512 second interval. #[derive(Debug, Clone, PartialEq, Eq)] pub struct TimeOverflowError { /// Time value in seconds that overflowed. diff --git a/units/src/result.rs b/units/src/result.rs index 8276e6cc1..97d6fefae 100644 --- a/units/src/result.rs +++ b/units/src/result.rs @@ -127,7 +127,7 @@ macro_rules! impl_opt_ext { } impl_opt_ext!(Amount, SignedAmount, u64, i64, FeeRate, Weight); -/// An error occurred while doing a mathematical operation. +/// Error returned when a mathematical operation fails. #[derive(Debug, Copy, Clone, PartialEq, Eq)] #[non_exhaustive] pub struct NumOpError(MathOp); diff --git a/units/src/weight.rs b/units/src/weight.rs index 50c08df97..22aea3836 100644 --- a/units/src/weight.rs +++ b/units/src/weight.rs @@ -12,7 +12,7 @@ use serde::{Deserialize, Serialize}; /// The factor that non-witness serialization data is multiplied by during weight calculation. pub const WITNESS_SCALE_FACTOR: usize = 4; -/// Represents weight - the weight of a transaction or block. +/// The weight of a transaction or block. /// /// This is an integer newtype representing [`Weight`] in `wu`. It provides protection against mixing /// up types as well as basic formatting features.