From 19109883de5edd536e3aa4aea13d0e3d1e7d1e0a Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Mon, 30 Jan 2017 23:42:27 -0500 Subject: [PATCH] Add doc example for `num_traits::Num::from_str_radix`. --- traits/src/lib.rs | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/traits/src/lib.rs b/traits/src/lib.rs index 2cd85d4..0aeb783 100644 --- a/traits/src/lib.rs +++ b/traits/src/lib.rs @@ -43,6 +43,18 @@ pub trait Num: PartialEq + Zero + One type FromStrRadixErr; /// Convert from a string and radix <= 36. + /// + /// # Examples + /// + /// ```rust + /// use num_traits::Num; + /// + /// let result = ::from_str_radix("27", 10); + /// assert_eq!(result, Ok(27)); + /// + /// let result = ::from_str_radix("foo", 10); + /// assert!(result.is_err()); + /// ``` fn from_str_radix(str: &str, radix: u32) -> Result; }