Skip to content

Commit

Permalink
Fix inappropriate ## headings
Browse files Browse the repository at this point in the history
Fixes #15499.
  • Loading branch information
steveklabnik committed Dec 10, 2014
1 parent bc486dc commit 6780031
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 19 deletions.
2 changes: 1 addition & 1 deletion src/libcollections/tree/mod.rs
Expand Up @@ -16,7 +16,7 @@
//!
//! `TreeMap`s are ordered.
//!
//! ## Example
//! # Examples
//!
//! ```{rust}
//! use std::collections::TreeSet;
Expand Down
2 changes: 1 addition & 1 deletion src/libcollections/tree/set.rs
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion src/libcore/simd.rs
Expand Up @@ -29,7 +29,7 @@
//! }
//! ```
//!
//! ## Stability Note
//! # Stability Note
//!
//! These are all experimental. The interface may change entirely, without
//! warning.
Expand Down
4 changes: 2 additions & 2 deletions src/libcore/str.rs
Expand Up @@ -1738,9 +1738,9 @@ pub trait StrPrelude for Sized? {
/// }
/// ```
///
/// ## Output
/// This outputs:
///
/// ```ignore
/// ```text
/// 0: 中
/// 3: 华
/// 6: V
Expand Down
11 changes: 5 additions & 6 deletions src/liblog/lib.rs
Expand Up @@ -10,7 +10,7 @@

//! Utilities for program-wide and customizable logging
//!
//! ## Example
//! # Examples
//!
//! ```
//! #![feature(phase)]
Expand Down Expand Up @@ -64,8 +64,7 @@
//! INFO:main: the answer was: 12
//! ```
//!
//!
//! ## Logging Macros
//! # Logging Macros
//!
//! There are five macros that the logging subsystem uses:
//!
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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:
//!
Expand Down
4 changes: 4 additions & 0 deletions src/librustdoc/html/toc.rs
Expand Up @@ -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>
}

Expand Down Expand Up @@ -78,6 +80,7 @@ impl TocBuilder {
///
/// Example:
///
/// ```text
/// ## A
/// # B
/// # C
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/libstd/io/buffered.rs
Expand Up @@ -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 }
Expand Down Expand Up @@ -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() }
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/io/stdio.rs
Expand Up @@ -125,7 +125,7 @@ impl StdinReader {
///
/// This provides access to methods like `chars` and `lines`.
///
/// ## Example
/// # Examples
///
/// ```rust
/// use std::io;
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/os.rs
Expand Up @@ -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.
Expand All @@ -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`).
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/task.rs
Expand Up @@ -32,7 +32,7 @@
//! the main task panics the application will exit with a non-zero
//! exit code.
//!
//! ## Example
//! # Examples
//!
//! ```rust
//! spawn(proc() {
Expand Down
2 changes: 1 addition & 1 deletion src/libterm/lib.rs
Expand Up @@ -16,7 +16,7 @@
//! [terminfo][ti] database, and `WinConsole`, which uses the [Win32 Console
//! API][win].
//!
//! ## Example
//! # Examples
//!
//! ```no_run
//! extern crate term;
Expand Down

0 comments on commit 6780031

Please sign in to comment.