about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2014-12-13 18:22:09 -0800
committerBrian Anderson <banderson@mozilla.com>2014-12-15 06:44:20 -0800
commit6c4a2bc55ffc4dcb64cab2e2772e012eb7a2c0c3 (patch)
treee02199009fdcb5bc841f561c3cf29055c40ea81e
parent34dfa7addb7cb57ef4f6e70f00fa8216c343104e (diff)
parent6780031540a708282be6262f820078f8e8198611 (diff)
downloadrust-6c4a2bc55ffc4dcb64cab2e2772e012eb7a2c0c3.tar.gz
rust-6c4a2bc55ffc4dcb64cab2e2772e012eb7a2c0c3.zip
rollup merge of #19710: steveklabnik/gh15449
Fixes #15499.
-rw-r--r--src/libcollections/tree/mod.rs2
-rw-r--r--src/libcollections/tree/set.rs2
-rw-r--r--src/libcore/simd.rs2
-rw-r--r--src/libcore/str.rs4
-rw-r--r--src/liblog/lib.rs11
-rw-r--r--src/librustdoc/html/toc.rs4
-rw-r--r--src/libstd/io/buffered.rs6
-rw-r--r--src/libstd/io/stdio.rs2
-rw-r--r--src/libstd/os.rs4
-rw-r--r--src/libstd/task.rs2
-rw-r--r--src/libterm/lib.rs2
11 files changed, 22 insertions, 19 deletions
diff --git a/src/libcollections/tree/mod.rs b/src/libcollections/tree/mod.rs
index 6b185950308..8c8a2c2f78e 100644
--- a/src/libcollections/tree/mod.rs
+++ b/src/libcollections/tree/mod.rs
@@ -15,7 +15,7 @@
 //!
 //! `TreeMap`s are ordered.
 //!
-//! ## Example
+//! # Examples
 //!
 //! ```{rust}
 //! use std::collections::TreeSet;
diff --git a/src/libcollections/tree/set.rs b/src/libcollections/tree/set.rs
index bd8bf5c6cb6..b48a610b849 100644
--- a/src/libcollections/tree/set.rs
+++ b/src/libcollections/tree/set.rs
@@ -27,7 +27,7 @@ use tree_map::{TreeMap, Entries, RevEntries, MoveEntries};
 /// requirement is that the type of the elements contained ascribes to the
 /// `Ord` trait.
 ///
-/// ## Examples
+/// # Examples
 ///
 /// ```{rust}
 /// use std::collections::TreeSet;
diff --git a/src/libcore/simd.rs b/src/libcore/simd.rs
index 369a7106583..252a24e3aa9 100644
--- a/src/libcore/simd.rs
+++ b/src/libcore/simd.rs
@@ -29,7 +29,7 @@
 //! }
 //! ```
 //!
-//! ## Stability Note
+//! # Stability Note
 //!
 //! These are all experimental. The interface may change entirely, without
 //! warning.
diff --git a/src/libcore/str.rs b/src/libcore/str.rs
index 92f82bd9771..e632934782c 100644
--- a/src/libcore/str.rs
+++ b/src/libcore/str.rs
@@ -1757,9 +1757,9 @@ pub trait StrPrelude for Sized? {
     /// }
     /// ```
     ///
-    /// ## Output
+    /// This outputs:
     ///
-    /// ```ignore
+    /// ```text
     /// 0: 中
     /// 3: 华
     /// 6: V
diff --git a/src/liblog/lib.rs b/src/liblog/lib.rs
index 8731f7084ed..0217c5b2713 100644
--- a/src/liblog/lib.rs
+++ b/src/liblog/lib.rs
@@ -10,7 +10,7 @@
 
 //! Utilities for program-wide and customizable logging
 //!
-//! ## Example
+//! # Examples
 //!
 //! ```
 //! #![feature(phase)]
@@ -64,8 +64,7 @@
 //! INFO:main: the answer was: 12
 //! ```
 //!
-//!
-//! ## Logging Macros
+//! # Logging Macros
 //!
 //! There are five macros that the logging subsystem uses:
 //!
@@ -86,7 +85,7 @@
 //!
 //! * `log_enabled!(level)` - returns true if logging of the given level is enabled
 //!
-//! ## Enabling logging
+//! # Enabling logging
 //!
 //! Log levels are controlled on a per-module basis, and by default all logging is
 //! disabled except for `error!` (a log level of 1). Logging is controlled via the
@@ -123,7 +122,7 @@
 //! * `hello,std::option` turns on hello, and std's option logging
 //! * `error,hello=warn` turn on global error logging and also warn for hello
 //!
-//! ## Filtering results
+//! # Filtering results
 //!
 //! A RUST_LOG directive may include a regex filter. The syntax is to append `/`
 //! followed by a regex. Each message is checked against the regex, and is only
@@ -143,7 +142,7 @@
 //!  hello. In both cases the log message must include a single digit number
 //!  followed by 'scopes'
 //!
-//! ## Performance and Side Effects
+//! # Performance and Side Effects
 //!
 //! Each of these macros will expand to code similar to:
 //!
diff --git a/src/librustdoc/html/toc.rs b/src/librustdoc/html/toc.rs
index 4d2f23e1c31..82081a01956 100644
--- a/src/librustdoc/html/toc.rs
+++ b/src/librustdoc/html/toc.rs
@@ -24,9 +24,11 @@ pub struct Toc {
     /// both of which end up in the same `Toc` as they have the same
     /// parent (Main).
     ///
+    /// ```text
     /// # Main
     /// ### A
     /// ## B
+    /// ```
     entries: Vec<TocEntry>
 }
 
@@ -78,6 +80,7 @@ impl TocBuilder {
     ///
     /// Example:
     ///
+    /// ```text
     /// ## A
     /// # B
     /// # C
@@ -86,6 +89,7 @@ impl TocBuilder {
     /// ### F
     /// #### G
     /// ### H
+    /// ```
     ///
     /// If we are considering H (i.e. level 3), then A and B are in
     /// self.top_level, D is in C.children, and C, E, F, G are in
diff --git a/src/libstd/io/buffered.rs b/src/libstd/io/buffered.rs
index a8de7356fe7..a16b84d0c16 100644
--- a/src/libstd/io/buffered.rs
+++ b/src/libstd/io/buffered.rs
@@ -80,7 +80,7 @@ impl<R: Reader> BufferedReader<R> {
 
     /// Gets a mutable reference to the underlying reader.
     ///
-    /// ## Warning
+    /// # Warning
     ///
     /// It is inadvisable to directly read from the underlying reader.
     pub fn get_mut(&mut self) -> &mut R { &mut self.inner }
@@ -185,7 +185,7 @@ impl<W: Writer> BufferedWriter<W> {
 
     /// Gets a mutable reference to the underlying write.
     ///
-    /// ## Warning
+    /// # Warning
     ///
     /// It is inadvisable to directly read from the underlying writer.
     pub fn get_mut(&mut self) -> &mut W { self.inner.as_mut().unwrap() }
@@ -357,7 +357,7 @@ impl<S: Stream> BufferedStream<S> {
 
     /// Gets a mutable reference to the underlying stream.
     ///
-    /// ## Warning
+    /// # Warning
     ///
     /// It is inadvisable to read directly from or write directly to the
     /// underlying stream.
diff --git a/src/libstd/io/stdio.rs b/src/libstd/io/stdio.rs
index 344012a09a0..53fac3fd3c9 100644
--- a/src/libstd/io/stdio.rs
+++ b/src/libstd/io/stdio.rs
@@ -127,7 +127,7 @@ impl StdinReader {
     ///
     /// This provides access to methods like `chars` and `lines`.
     ///
-    /// ## Example
+    /// # Examples
     ///
     /// ```rust
     /// use std::io;
diff --git a/src/libstd/os.rs b/src/libstd/os.rs
index a3ecfb49ace..a8d854a7555 100644
--- a/src/libstd/os.rs
+++ b/src/libstd/os.rs
@@ -1237,7 +1237,7 @@ impl Copy for MapOption {}
 
 /// Possible errors when creating a map.
 pub enum MapError {
-    /// ## The following are POSIX-specific
+    /// # The following are POSIX-specific
     ///
     /// fd was not open for reading or, if using `MapWritable`, was not open for
     /// writing.
@@ -1259,7 +1259,7 @@ pub enum MapError {
     ErrZeroLength,
     /// Unrecognized error. The inner value is the unrecognized errno.
     ErrUnknown(int),
-    /// ## The following are Windows-specific
+    /// # The following are Windows-specific
     ///
     /// Unsupported combination of protection flags
     /// (`MapReadable`/`MapWritable`/`MapExecutable`).
diff --git a/src/libstd/task.rs b/src/libstd/task.rs
index 340e283708a..562afd33e2f 100644
--- a/src/libstd/task.rs
+++ b/src/libstd/task.rs
@@ -32,7 +32,7 @@
 //! the main task panics the application will exit with a non-zero
 //! exit code.
 //!
-//! ## Example
+//! # Examples
 //!
 //! ```rust
 //! spawn(move|| {
diff --git a/src/libterm/lib.rs b/src/libterm/lib.rs
index 575ec860f97..e8824b1ad2c 100644
--- a/src/libterm/lib.rs
+++ b/src/libterm/lib.rs
@@ -16,7 +16,7 @@
 //! [terminfo][ti] database, and `WinConsole`, which uses the [Win32 Console
 //! API][win].
 //!
-//! ## Example
+//! # Examples
 //!
 //! ```no_run
 //! extern crate term;