From c78a48fd35065e4d62e19fac988f5d753ad70727 Mon Sep 17 00:00:00 2001 From: Jacob Kiesel Date: Wed, 8 Feb 2017 15:10:01 -0700 Subject: [PATCH] Improve documentation comments Remove passive voice from documentation comments. --- traits/src/lib.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/traits/src/lib.rs b/traits/src/lib.rs index 23063fe..4b4ed9c 100644 --- a/traits/src/lib.rs +++ b/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(input: T, min: T, max: T) -> T { debug_assert!(min <= max, "min must be less than or equal to max");