From 80130005da9eb17563e920747422f375b1d598bc Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Wed, 30 Sep 2015 17:42:41 -0400 Subject: [PATCH] Add some docs for FromString::from_str @marchelzo pointed out on IRC that this doesn't have docs, so, let's change that. --- src/libcore/str/mod.rs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/libcore/str/mod.rs b/src/libcore/str/mod.rs index 3c7f1b368839..be2186945d56 100644 --- a/src/libcore/str/mod.rs +++ b/src/libcore/str/mod.rs @@ -48,6 +48,21 @@ pub trait FromStr: Sized { /// If parsing succeeds, return the value inside `Ok`, otherwise /// when the string is ill-formatted return an error specific to the /// inside `Err`. The error type is specific to implementation of the trait. + /// + /// # Examples + /// + /// Basic usage with [`i32`][ithirtytwo], a type that implements `FromStr`: + /// + /// [ithirtytwo]: ../primitive.i32.html + /// + /// ``` + /// use std::str::FromStr; + /// + /// let s = "5"; + /// let x = i32::from_str(s).unwrap(); + /// + /// assert_eq!(5, x); + /// ``` #[stable(feature = "rust1", since = "1.0.0")] fn from_str(s: &str) -> Result; }