diff --git a/src/lib.rs b/src/lib.rs index 431ddd5..dfb4387 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -45,7 +45,12 @@ use num_traits::{ mod pow; -/// Represents the ratio between two numbers. +/// Represents the ratio between two integers. +/// +/// Converting to a `Ratio` yields `None` in the following cases: +/// +/// - The input value is out of the bounds of the integer target type, which, in case of a float, includes positive and negative infinity. +/// - The input value is a float and NaN. #[derive(Copy, Clone, Debug)] #[allow(missing_docs)] pub struct Ratio {