about summary refs log tree commit diff
path: root/src/liballoc
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2015-03-12 09:13:47 +0530
committerManish Goregaokar <manishsmail@gmail.com>2015-03-12 09:13:47 +0530
commit0a74387b642bfc6ba0c8de723942eafae440bc4a (patch)
tree109b0be66b72fa83a755169299dbcbdc3e2b8b97 /src/liballoc
parent2c251fa84694112890d879cd5fe05d18006f0a0c (diff)
parent64ab111b5387e9985df188a970350c9e6c7f1451 (diff)
downloadrust-0a74387b642bfc6ba0c8de723942eafae440bc4a.tar.gz
rust-0a74387b642bfc6ba0c8de723942eafae440bc4a.zip
Rollup merge of #23297 - steveklabnik:examples, r=huonw
 This brings comments in line with https://github.com/rust-lang/rfcs/blob/master/text/0505-api-comment-conventions.md#using-markdown
Diffstat (limited to 'src/liballoc')
-rw-r--r--src/liballoc/arc.rs2
-rw-r--r--src/liballoc/boxed.rs2
-rw-r--r--src/liballoc/rc.rs4
3 files changed, 4 insertions, 4 deletions
diff --git a/src/liballoc/arc.rs b/src/liballoc/arc.rs
index dc1938cac1a..748eb9dcb2f 100644
--- a/src/liballoc/arc.rs
+++ b/src/liballoc/arc.rs
@@ -88,7 +88,7 @@ use heap::deallocate;
 
 /// An atomically reference counted wrapper for shared state.
 ///
-/// # Example
+/// # Examples
 ///
 /// In this example, a large vector of floats is shared between several tasks.
 /// With simple pipes, without `Arc`, a copy would have to be made for each
diff --git a/src/liballoc/boxed.rs b/src/liballoc/boxed.rs
index 9351b110100..6d865d2bffa 100644
--- a/src/liballoc/boxed.rs
+++ b/src/liballoc/boxed.rs
@@ -133,7 +133,7 @@ impl<T : ?Sized> Box<T> {
 /// automatically managed that may lead to memory or other resource
 /// leak.
 ///
-/// # Example
+/// # Examples
 /// ```
 /// use std::boxed;
 ///
diff --git a/src/liballoc/rc.rs b/src/liballoc/rc.rs
index 763dcc7f256..115acd4a0ef 100644
--- a/src/liballoc/rc.rs
+++ b/src/liballoc/rc.rs
@@ -264,7 +264,7 @@ pub fn is_unique<T>(rc: &Rc<T>) -> bool {
 ///
 /// If the `Rc<T>` is not unique, an `Err` is returned with the same `Rc<T>`.
 ///
-/// # Example
+/// # Examples
 ///
 /// ```
 /// use std::rc::{self, Rc};
@@ -298,7 +298,7 @@ pub fn try_unwrap<T>(rc: Rc<T>) -> Result<T, Rc<T>> {
 ///
 /// Returns `None` if the `Rc<T>` is not unique.
 ///
-/// # Example
+/// # Examples
 ///
 /// ```
 /// use std::rc::{self, Rc};