Remove warning section
Since monadic handling has been introduced, panics have been replaced with return errors. Therefore this section is no longer applicable.
This commit is contained in:
parent
86266d2dad
commit
2f897e2109
|
@ -22,17 +22,6 @@ use super::{
|
||||||
/// conversion to various denominations. The [`Amount`] type does not implement [`serde`] traits
|
/// conversion to various denominations. The [`Amount`] type does not implement [`serde`] traits
|
||||||
/// but we do provide modules for serializing as satoshis or bitcoin.
|
/// but we do provide modules for serializing as satoshis or bitcoin.
|
||||||
///
|
///
|
||||||
/// Warning!
|
|
||||||
///
|
|
||||||
/// This type implements several arithmetic operations from [`core::ops`].
|
|
||||||
/// To prevent errors due to overflow or underflow when using these operations,
|
|
||||||
/// it is advised to instead use the checked arithmetic methods whose names
|
|
||||||
/// start with `checked_`. The operations from [`core::ops`] that [`Amount`]
|
|
||||||
/// implements will panic when overflow or underflow occurs. Also note that
|
|
||||||
/// since the internal representation of amounts is unsigned, subtracting below
|
|
||||||
/// zero is considered an underflow and will cause a panic if you're not using
|
|
||||||
/// the checked arithmetic methods.
|
|
||||||
///
|
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
|
|
Loading…
Reference in New Issue