about summary refs log tree commit diff
diff options
context:
space:
mode:
authorkennytm <kennytm@gmail.com>2017-11-28 03:16:45 +0800
committerGitHub <noreply@github.com>2017-11-28 03:16:45 +0800
commit840e6c12ba0b6ab500040b65c10b611ef201f8af (patch)
tree50ee2881e9652aee2209be5de95c1a9de68a52de
parent26330b17572b106c6c1ce6c7e049b0dc25ee058e (diff)
parent5962d7e0079c4c2156a783e156a76c5d0824df22 (diff)
downloadrust-840e6c12ba0b6ab500040b65c10b611ef201f8af.tar.gz
rust-840e6c12ba0b6ab500040b65c10b611ef201f8af.zip
Rollup merge of #46240 - SimonSapin:from_str_radix-docs, r=estebank
Expand docs of <$Int>::from_str_radix, based on that of char::to_digit
-rw-r--r--src/libcore/num/mod.rs18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs
index 1230066e2b3..19e91a65964 100644
--- a/src/libcore/num/mod.rs
+++ b/src/libcore/num/mod.rs
@@ -132,7 +132,14 @@ macro_rules! int_impl {
 
         /// Converts a string slice in a given base to an integer.
         ///
+        /// The string is expected to be an optional `+` or `-` sign
+        /// followed by digits.
         /// Leading and trailing whitespace represent an error.
+        /// Digits are a subset of these characters, depending on `radix`:
+        ///
+        /// * `0-9`
+        /// * `a-z`
+        /// * `A-Z`
         ///
         /// # Panics
         ///
@@ -1301,7 +1308,18 @@ macro_rules! uint_impl {
 
         /// Converts a string slice in a given base to an integer.
         ///
+        /// The string is expected to be an optional `+` sign
+        /// followed by digits.
         /// Leading and trailing whitespace represent an error.
+        /// Digits are a subset of these characters, depending on `radix`:
+        ///
+        /// * `0-9`
+        /// * `a-z`
+        /// * `A-Z`
+        ///
+        /// # Panics
+        ///
+        /// This function panics if `radix` is not in the range from 2 to 36.
         ///
         /// # Examples
         ///