From 6780031540a708282be6262f820078f8e8198611 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Wed, 10 Dec 2014 13:54:56 -0500 Subject: [PATCH] Fix inappropriate ## headings Fixes #15499. --- src/libcollections/tree/mod.rs | 2 +- src/libcollections/tree/set.rs | 2 +- src/libcore/simd.rs | 2 +- src/libcore/str.rs | 4 ++-- src/liblog/lib.rs | 11 +++++------ src/librustdoc/html/toc.rs | 4 ++++ src/libstd/io/buffered.rs | 6 +++--- src/libstd/io/stdio.rs | 2 +- src/libstd/os.rs | 4 ++-- src/libstd/task.rs | 2 +- src/libterm/lib.rs | 2 +- 11 files changed, 22 insertions(+), 19 deletions(-) diff --git a/src/libcollections/tree/mod.rs b/src/libcollections/tree/mod.rs index 20823a2affc7f..5362b06c5b99c 100644 --- a/src/libcollections/tree/mod.rs +++ b/src/libcollections/tree/mod.rs @@ -16,7 +16,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 ea9aff564483f..72bd4e6654e69 100644 --- a/src/libcollections/tree/set.rs +++ b/src/libcollections/tree/set.rs @@ -27,7 +27,7 @@ use tree_map::{TreeMap, Entries, RevEntries, MoveEntries}; /// only 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 369a710658307..252a24e3aa913 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 baa739b06833c..7e2b681972834 100644 --- a/src/libcore/str.rs +++ b/src/libcore/str.rs @@ -1738,9 +1738,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 8b79078eac6ad..05c521ad30048 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 4d2f23e1c314e..82081a01956bb 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 } @@ -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 a8de7356fe7d1..a16b84d0c167e 100644 --- a/src/libstd/io/buffered.rs +++ b/src/libstd/io/buffered.rs @@ -80,7 +80,7 @@ impl BufferedReader { /// 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 BufferedWriter { /// 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 BufferedStream { /// 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 48c333f0733a5..6d6babfe699ec 100644 --- a/src/libstd/io/stdio.rs +++ b/src/libstd/io/stdio.rs @@ -125,7 +125,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 6c91010f4cb35..d214cda0d127a 100644 --- a/src/libstd/os.rs +++ b/src/libstd/os.rs @@ -1235,7 +1235,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. @@ -1257,7 +1257,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 c91417e611ed1..d179b94931dc2 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(proc() { diff --git a/src/libterm/lib.rs b/src/libterm/lib.rs index 575ec860f973e..e8824b1ad2ca1 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;