From 07b2ca2e1f32807faf00af1285566fdb38fb6658 Mon Sep 17 00:00:00 2001
From: bluss <bluss@users.noreply.github.com>
Date: Wed, 17 Feb 2016 23:08:46 +0100
Subject: [PATCH] Edit docs for methods returning Result

---
 src/array_string.rs | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/src/array_string.rs b/src/array_string.rs
index a9b9f1a..a6410c2 100644
--- a/src/array_string.rs
+++ b/src/array_string.rs
@@ -50,6 +50,8 @@ impl<A: Array<Item=u8>> ArrayString<A> {
     ///
     /// Capacity is inferred from the type parameter.
     ///
+    /// **Errors** if the backing array is not large enough to fit the string.
+    ///
     /// ```
     /// use arrayvec::ArrayString;
     ///
@@ -77,8 +79,9 @@ impl<A: Array<Item=u8>> ArrayString<A> {
 
     /// Adds the given char to the end of the string.
     ///
-    /// Returns `Ok` if the push succeeds, and returns `Err` if the backing
-    /// array is not large enough to fit the additional char.
+    /// Returns `Ok` if the push succeeds.
+    ///
+    /// **Errors** if the backing array is not large enough to fit the additional char.
     ///
     /// ```
     /// use arrayvec::ArrayString;
@@ -99,8 +102,9 @@ impl<A: Array<Item=u8>> ArrayString<A> {
 
     /// Adds the given string slice to the end of the string.
     ///
-    /// Returns `Ok` if the push succeeds, and returns `Err` if the
-    /// backing array is not large enough to fit the string.
+    /// Returns `Ok` if the push succeeds.
+    ///
+    /// **Errors** if the backing array is not large enough to fit the string.
     ///
     /// ```
     /// use arrayvec::ArrayString;