Browse Source

Improve documentation comments

Remove passive voice from documentation comments.
Jacob Kiesel 8 years ago
parent
commit
c78a48fd35
1 changed files with 3 additions and 2 deletions
  1. 3 2
      traits/src/lib.rs

+ 3 - 2
traits/src/lib.rs

@@ -243,8 +243,9 @@ float_trait_impl!(Num for f32 f64);
 
 /// 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
-/// returned.  Otherwise input is returned.
+///  If input is less than min then this returns min. 
+///  If input is greater than max then this returns max.  
+///  Otherwise this returns input. 
 #[inline]
 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");