blockworks-foundation
/
fixed
mirror of https://github.com/blockworks-foundation/fixed.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc tweaks

This commit is contained in:
Trevor Spiteri 2019-02-07 22:01:37 +01:00
parent 7d99bf3fbf
commit bdf6f9fe88
1 changed files with 9 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/macros_round.rs
View File

@ -112,11 +112,9 @@ assert_eq!((-two_and_quarter).frac(), three_quarters);
# Panics
If the result is too large to fit, the method panics in debug mode. In
release mode, the method may either panic or wrap the value, with the
current implementation wrapping the value. It is not considered a
breaking change if in the future the method panics even in release
mode; if wrapping is the required behavior use [`wrapping_ceil`]
In debug mode, panics if the result does not fit. In release mode the
result is wrapped, but it is not considered a breaking change if in
the future it panics; if wrapping is required use [`wrapping_ceil`]
instead.
# Examples
@ -154,11 +152,9 @@ assert_eq!(two_half.ceil(), Fix::from_int(3));
$Signedness,
"# Panics
If the result is too large to fit, the method panics in debug mode. In
release mode, the method may either panic or wrap the value, with the
current implementation wrapping the value. It is not considered a
breaking change if in the future the method panics even in release
mode; if wrapping is the required behavior use [`wrapping_floor`]
In debug mode, panics if the result does not fit. In release mode the
result is wrapped, but it is not considered a breaking change if in
the future it panics; if wrapping is required use [`wrapping_floor`]
instead.
Overflow can only occur when there are zero integer bits.
@ -198,11 +194,9 @@ from zero.
# Panics
If the result is too large to fit, the method panics in debug mode. In
release mode, the method may either panic or wrap the value, with the
current implementation wrapping the value. It is not considered a
breaking change if in the future the method panics even in release
mode; if wrapping is the required behavior use [`wrapping_round`]
In debug mode, panics if the result does not fit. In release mode the
result is wrapped, but it is not considered a breaking change if in
the future it panics; if wrapping is required use [`wrapping_round`]
instead.
# Examples