]> git.lizzy.rs Git - rust.git/commitdiff
Fix `borrow` docs
authorAndrew Paseltiner <apaseltiner@gmail.com>
Thu, 9 Apr 2015 16:51:19 +0000 (12:51 -0400)
committerAndrew Paseltiner <apaseltiner@gmail.com>
Thu, 9 Apr 2015 16:51:19 +0000 (12:51 -0400)
src/libcollections/borrow.rs

index 4503ad14e92b49b9bea7b625a31289c131771fae..7332bf4670ae58efd9ce4c42a7143b2e6fc6d31c 100644 (file)
@@ -39,7 +39,7 @@
 /// Borrow<Vec<T>>` and `Vec<T>: Borrow<[T]>`.
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait Borrow<Borrowed: ?Sized> {
-    /// Immutably borrow from an owned value.
+    /// Immutably borrows from an owned value.
     ///
     /// # Examples
     ///
@@ -67,7 +67,7 @@ pub trait Borrow<Borrowed: ?Sized> {
 /// Similar to `Borrow`, but for mutable borrows.
 #[stable(feature = "rust1", since = "1.0.0")]
 pub trait BorrowMut<Borrowed: ?Sized> : Borrow<Borrowed> {
-    /// Mutably borrow from an owned value.
+    /// Mutably borrows from an owned value.
     ///
     /// # Examples
     ///
@@ -126,7 +126,7 @@ fn borrow(&self) -> &B {
     }
 }
 
-/// A generalization of Clone to borrowed data.
+/// A generalization of `Clone` to borrowed data.
 ///
 /// Some types make it possible to go from borrowed to owned, usually by
 /// implementing the `Clone` trait. But `Clone` works only for going from `&T`
@@ -137,7 +137,7 @@ pub trait ToOwned {
     #[stable(feature = "rust1", since = "1.0.0")]
     type Owned: Borrow<Self>;
 
-    /// Create owned data from borrowed data, usually by copying.
+    /// Creates owned data from borrowed data, usually by cloning.
     #[stable(feature = "rust1", since = "1.0.0")]
     fn to_owned(&self) -> Self::Owned;
 }
@@ -155,9 +155,9 @@ fn to_owned(&self) -> T { self.clone() }
 /// data lazily when mutation or ownership is required. The type is designed to
 /// work with general borrowed data via the `Borrow` trait.
 ///
-/// `Cow` implements both `Deref`, which means that you can call
+/// `Cow` implements `Deref`, which means that you can call
 /// non-mutating methods directly on the data it encloses. If mutation
-/// is desired, `to_mut` will obtain a mutable references to an owned
+/// is desired, `to_mut` will obtain a mutable reference to an owned
 /// value, cloning if necessary.
 ///
 /// # Examples
@@ -200,7 +200,7 @@ fn clone(&self) -> Cow<'a, B> {
 }
 
 impl<'a, B: ?Sized> Cow<'a, B> where B: ToOwned {
-    /// Acquire a mutable reference to the owned form of the data.
+    /// Acquires a mutable reference to the owned form of the data.
     ///
     /// Copies the data if it is not already owned.
     ///
@@ -226,7 +226,7 @@ pub fn to_mut(&mut self) -> &mut <B as ToOwned>::Owned {
         }
     }
 
-    /// Extract the owned data.
+    /// Extracts the owned data.
     ///
     /// Copies the data if it is not already owned.
     ///
@@ -327,7 +327,7 @@ fn hash<H: Hasher>(&self, state: &mut H) {
     }
 }
 
-/// Trait for moving into a `Cow`
+/// Trait for moving into a `Cow`.
 #[unstable(feature = "into_cow", reason = "may be replaced by `convert::Into`")]
 pub trait IntoCow<'a, B: ?Sized> where B: ToOwned {
     /// Moves `self` into `Cow`