about summary refs log tree commit diff
path: root/src/libcore/num
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-05-18 16:58:29 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-05-18 17:13:59 -0400
commit1254c34032673d5f9d7775d894bc58e7ad68ba01 (patch)
treef3de2bb82e66f3f369084f93b94f79860d0d845f /src/libcore/num
parent2dd5ad0be84f8d14dc357fb35a4b21fe5a34030a (diff)
downloadrust-1254c34032673d5f9d7775d894bc58e7ad68ba01.tar.gz
rust-1254c34032673d5f9d7775d894bc58e7ad68ba01.zip
Add example for from_str_radix
Fixes #25517
Diffstat (limited to 'src/libcore/num')
-rw-r--r--src/libcore/num/mod.rs12
1 files changed, 4 insertions, 8 deletions
diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs
index 011830ddb78..75040b4c425 100644
--- a/src/libcore/num/mod.rs
+++ b/src/libcore/num/mod.rs
@@ -132,15 +132,11 @@ macro_rules! int_impl {
         ///
         /// Leading and trailing whitespace represent an error.
         ///
-        /// # Arguments
-        ///
-        /// * src - A string slice
-        /// * radix - The base to use. Must lie in the range [2 .. 36]
-        ///
-        /// # Return value
+        /// # Examples
         ///
-        /// `Err(ParseIntError)` if the string did not represent a valid number.
-        /// Otherwise, `Ok(n)` where `n` is the integer represented by `src`.
+        /// ```
+        /// assert_eq!(u32::from_str_radix("A", 16), Some(10));
+        /// ```
         #[stable(feature = "rust1", since = "1.0.0")]
         #[allow(deprecated)]
         pub fn from_str_radix(src: &str, radix: u32) -> Result<$T, ParseIntError> {