about summary refs log tree commit diff
diff options
context:
space:
mode:
authorjbranchaud <jbranchaud@gmail.com>2014-12-15 16:40:27 -0600
committerjbranchaud <jbranchaud@gmail.com>2014-12-15 16:40:27 -0600
commita9dbb7908dd851dff81f613452518db3ba04887c (patch)
tree0d0db3f453bb58989b534394a43fe2ed334097f1
parent92e9e70d15bcf8d29890bf93793be402ad629229 (diff)
downloadrust-a9dbb7908dd851dff81f613452518db3ba04887c.tar.gz
rust-a9dbb7908dd851dff81f613452518db3ba04887c.zip
Add a doctest for the string Add function.
-rw-r--r--src/libcollections/string.rs10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs
index c4659f86680..3dd24fc33ae 100644
--- a/src/libcollections/string.rs
+++ b/src/libcollections/string.rs
@@ -857,6 +857,16 @@ impl<'a, S: Str> Equiv<S> for String {
 
 #[experimental = "waiting on Add stabilization"]
 impl<S: Str> Add<S, String> for String {
+    /// Concatenates `self` and `other` as a new mutable `String`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// let string1 = "foo".to_string();
+    /// let string2 = "bar".to_string();
+    /// let string3 = string1 + string2;
+    /// assert_eq!(string3, "foobar".to_string());
+    /// ```
     fn add(&self, other: &S) -> String {
         let mut s = String::from_str(self.as_slice());
         s.push_str(other.as_slice());