about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume.gomez@huawei.com>2022-09-21 14:17:11 +0200
committerGuillaume Gomez <guillaume.gomez@huawei.com>2022-09-21 14:17:11 +0200
commitb4fdc5861d46dc9204a8a4a51fa287360090ec3c (patch)
treedea631f8a17b08dd859306fe0193968d91491a91
parent8fd6d03e22fba2930ad377b87299de6a37076074 (diff)
downloadrust-b4fdc5861d46dc9204a8a4a51fa287360090ec3c.tar.gz
rust-b4fdc5861d46dc9204a8a4a51fa287360090ec3c.zip
Add missing documentation for `bool::from_str`
-rw-r--r--library/core/src/str/traits.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/library/core/src/str/traits.rs b/library/core/src/str/traits.rs
index e9649fc91fa..18f2ce6edc7 100644
--- a/library/core/src/str/traits.rs
+++ b/library/core/src/str/traits.rs
@@ -573,8 +573,8 @@ impl FromStr for bool {
 
     /// Parse a `bool` from a string.
     ///
-    /// Yields a `Result<bool, ParseBoolError>`, because `s` may or may not
-    /// actually be parseable.
+    /// The only accepted values are `"true"` and `"false"`. Any other input
+    /// will return an error.
     ///
     /// # Examples
     ///