From aa8386e8574da18b667b994d7f4a20d99801bed1 Mon Sep 17 00:00:00 2001 From: Jorge Aparicio Date: Thu, 1 Mar 2018 20:20:34 +0100 Subject: [PATCH] doc tweaks --- src/string.rs | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/string.rs b/src/string.rs index 474d5675..4f8d07ba 100644 --- a/src/string.rs +++ b/src/string.rs @@ -4,7 +4,7 @@ use core::str::Utf8Error; use {BufferFullError, Vec}; -/// A String, backed by a fixed size array `heapless::Vec` +/// A String backed by a fixed size `heapless::Vec` /// /// String: https://doc.rust-lang.org/std/string/struct.String.html @@ -86,7 +86,7 @@ where /// Converts a vector of bytes to a `String` without checking that the /// string contains valid UTF-8. /// - /// See the safe version, [`from_utf8`], for more details. + /// See the safe version, `from_utf8`, for more details. #[inline] pub unsafe fn from_utf8_unchecked(vec: Vec) -> String { String { vec: vec } @@ -153,7 +153,6 @@ where } /// Appends a given string slice onto the end of this `String`. - /// Returns with a Result<(), BufferFullError>. /// /// # Examples /// @@ -193,7 +192,6 @@ where } /// Appends the given [`char`] to the end of this `String`. - /// Assumes ch.len_utf8() == 1 /// /// [`char`]: ../../std/primitive.char.html ///