xeos
/
num-traits
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve documentation comments 

Remove passive voice from documentation comments.
This commit is contained in:
Jacob Kiesel 2017-02-08 15:10:01 -07:00 committed by GitHub
parent 17665ec50d
commit c78a48fd35
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
traits/src/lib.rs
View File

@ -243,8 +243,9 @@ float_trait_impl!(Num for f32 f64);
/// A value bounded by a minimum and a maximum /// A value bounded by a minimum and a maximum
/// ///
/// If input is less than min then min is returned, if input is greater than max then max is /// If input is less than min then this returns min.
/// returned. Otherwise input is returned. /// If input is greater than max then this returns max.
/// Otherwise this returns input.
#[inline] #[inline]
pub fn clamp<T: PartialOrd>(input: T, min: T, max: T) -> T { pub fn clamp<T: PartialOrd>(input: T, min: T, max: T) -> T {
debug_assert!(min <= max, "min must be less than or equal to max"); debug_assert!(min <= max, "min must be less than or equal to max");