From 973ba72e4f81a0999181b5134c80a38ed14532ed Mon Sep 17 00:00:00 2001 From: Toshiki Teramura Date: Sat, 31 Aug 2019 15:34:40 +0900 Subject: [PATCH] Fix doc comment --- src/lib.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 12335ee..2215a60 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -375,7 +375,7 @@ pub fn clamp(input: T, min: T, max: T) -> T { /// /// If input is less than min then this returns min. /// Otherwise this returns input. -/// Preserves `NaN` different from `min`. +/// `clamp_min(std::f32::NAN, 1.0)` preserves `NAN` different from `f32::min(std::f32::NAN, 1.0)`. #[inline] pub fn clamp_min(input: T, min: T) -> T { if input < min { @@ -389,7 +389,7 @@ pub fn clamp_min(input: T, min: T) -> T { /// /// If input is less than min then this returns min. /// Otherwise this returns input. -/// Preserves `NaN` different from `max`. +/// `clamp_max(std::f32::NAN, 1.0)` preserves `NAN` different from `f32::max(std::f32::NAN, 1.0)`. #[inline] pub fn clamp_max(input: T, max: T) -> T { if input > max {