about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-11-30 14:36:03 -0500
committerSteve Klabnik <steve@steveklabnik.com>2015-11-30 14:36:03 -0500
commita9b6975c87adde151407ad4eb695f78cf4828f39 (patch)
tree91cc547023430a60760c8d3c12f6ec351f29099c /src
parent8bc43ed59d24c014ccfe6ed63c6a9afd5e3b811c (diff)
Write some docs for ToString
Part of #29376
Diffstat (limited to 'src')
-rw-r--r--src/libcollections/string.rs22
1 files changed, 20 insertions, 2 deletions
diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs
index 9f09facdaf7..5692d648849 100644
--- a/src/libcollections/string.rs
+++ b/src/libcollections/string.rs
@@ -1179,10 +1179,28 @@ impl PartialEq for ParseError {
 #[stable(feature = "str_parse_error", since = "1.5.0")]
 impl Eq for ParseError {}
 
-/// A generic trait for converting a value to a string
+/// A trait for converting a value to a `String`.
+///
+/// This trait is automatically implemented for any type which implements the
+/// [`Display`] trait. As such, `ToString` shouldn't be implemented directly:
+/// [`Display`] should be implemented instead, and you get the `ToString`
+/// implementation for free.
+///
+/// [`Display`]: ../fmt/trait.Display.html
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait ToString {
-    /// Converts the value of `self` to an owned string
+    /// Converts the given value to a `String`.
+    ///
+    /// # Examples
+    ///
+    /// Basic usage:
+    ///
+    /// ```
+    /// let i = 5;
+    /// let five = String::from("5");
+    ///
+    /// assert_eq!(five, i.to_string());
+    /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     fn to_string(&self) -> String;
 }