diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2015-03-11 21:11:40 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2015-03-11 21:11:40 -0400 |
| commit | 64ab111b5387e9985df188a970350c9e6c7f1451 (patch) | |
| tree | b53d97e99191c256cd0bcfd9c510652b454e8477 /src/libstd | |
| parent | f899513a30165946a75ff7f515ab37a226e72172 (diff) | |
| download | rust-64ab111b5387e9985df188a970350c9e6c7f1451.tar.gz rust-64ab111b5387e9985df188a970350c9e6c7f1451.zip | |
Example -> Examples
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/libstd')
40 files changed, 195 insertions, 195 deletions
diff --git a/src/libstd/collections/hash/map.rs b/src/libstd/collections/hash/map.rs index 9502302aa53..18f86901b8f 100644 --- a/src/libstd/collections/hash/map.rs +++ b/src/libstd/collections/hash/map.rs @@ -225,7 +225,7 @@ fn test_resize_policy() { /// 3. Emmanuel Goossaert. ["Robin Hood hashing: backward shift /// deletion"](http://codecapsule.com/2013/11/17/robin-hood-hashing-backward-shift-deletion/) /// -/// # Example +/// # Examples /// /// ``` /// use std::collections::HashMap; @@ -497,7 +497,7 @@ impl<K, V, S> HashMap<K, V, S> impl<K: Hash + Eq, V> HashMap<K, V, RandomState> { /// Create an empty HashMap. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -511,7 +511,7 @@ impl<K: Hash + Eq, V> HashMap<K, V, RandomState> { /// Creates an empty hash map with the given initial capacity. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -531,7 +531,7 @@ impl<K, V, S> HashMap<K, V, S> /// /// The creates map has the default initial capacity. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -559,7 +559,7 @@ impl<K, V, S> HashMap<K, V, S> /// cause many collisions and very poor performance. Setting it /// manually using this function can expose a DoS attack vector. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -586,7 +586,7 @@ impl<K, V, S> HashMap<K, V, S> /// Returns the number of elements the map can hold without reallocating. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -607,7 +607,7 @@ impl<K, V, S> HashMap<K, V, S> /// /// Panics if the new allocation size overflows `usize`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -714,7 +714,7 @@ impl<K, V, S> HashMap<K, V, S> /// down as much as possible while maintaining the internal rules /// and possibly leaving some space in accordance with the resize policy. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -806,7 +806,7 @@ impl<K, V, S> HashMap<K, V, S> /// An iterator visiting all keys in arbitrary order. /// Iterator element type is `&'a K`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -831,7 +831,7 @@ impl<K, V, S> HashMap<K, V, S> /// An iterator visiting all values in arbitrary order. /// Iterator element type is `&'a V`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -856,7 +856,7 @@ impl<K, V, S> HashMap<K, V, S> /// An iterator visiting all key-value pairs in arbitrary order. /// Iterator element type is `(&'a K, &'a V)`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -879,7 +879,7 @@ impl<K, V, S> HashMap<K, V, S> /// with mutable references to the values. /// Iterator element type is `(&'a K, &'a mut V)`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -907,7 +907,7 @@ impl<K, V, S> HashMap<K, V, S> /// pair out of the map in arbitrary order. The map cannot be used after /// calling this. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -942,7 +942,7 @@ impl<K, V, S> HashMap<K, V, S> /// Returns the number of elements in the map. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -957,7 +957,7 @@ impl<K, V, S> HashMap<K, V, S> /// Returns true if the map contains no elements. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -974,7 +974,7 @@ impl<K, V, S> HashMap<K, V, S> /// Clears the map, returning all key-value pairs as an iterator. Keeps the /// allocated memory for reuse. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1005,7 +1005,7 @@ impl<K, V, S> HashMap<K, V, S> /// Clears the map, removing all key-value pairs. Keeps the allocated memory /// for reuse. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1027,7 +1027,7 @@ impl<K, V, S> HashMap<K, V, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the key type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1050,7 +1050,7 @@ impl<K, V, S> HashMap<K, V, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the key type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1073,7 +1073,7 @@ impl<K, V, S> HashMap<K, V, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the key type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1096,7 +1096,7 @@ impl<K, V, S> HashMap<K, V, S> /// Inserts a key-value pair from the map. If the key already had a value /// present in the map, that value is returned. Otherwise, `None` is returned. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; @@ -1128,7 +1128,7 @@ impl<K, V, S> HashMap<K, V, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the key type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashMap; diff --git a/src/libstd/collections/hash/set.rs b/src/libstd/collections/hash/set.rs index cdc0ebd76aa..35115ad77fe 100644 --- a/src/libstd/collections/hash/set.rs +++ b/src/libstd/collections/hash/set.rs @@ -38,7 +38,7 @@ use super::state::HashState; /// HashMap where the value is (). As with the `HashMap` type, a `HashSet` /// requires that the elements implement the `Eq` and `Hash` traits. /// -/// # Example +/// # Examples /// /// ``` /// use std::collections::HashSet; @@ -100,7 +100,7 @@ pub struct HashSet<T, S = RandomState> { impl<T: Hash + Eq> HashSet<T, RandomState> { /// Create an empty HashSet. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -115,7 +115,7 @@ impl<T: Hash + Eq> HashSet<T, RandomState> { /// Create an empty HashSet with space for at least `n` elements in /// the hash table. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -136,7 +136,7 @@ impl<T, S> HashSet<T, S> /// /// The hash set is also created with the default initial capacity. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -160,7 +160,7 @@ impl<T, S> HashSet<T, S> /// cause many collisions and very poor performance. Setting it /// manually using this function can expose a DoS attack vector. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -181,7 +181,7 @@ impl<T, S> HashSet<T, S> /// Returns the number of elements the set can hold without reallocating. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -202,7 +202,7 @@ impl<T, S> HashSet<T, S> /// /// Panics if the new allocation size overflows `usize`. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -218,7 +218,7 @@ impl<T, S> HashSet<T, S> /// down as much as possible while maintaining the internal rules /// and possibly leaving some space in accordance with the resize policy. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -238,7 +238,7 @@ impl<T, S> HashSet<T, S> /// An iterator visiting all elements in arbitrary order. /// Iterator element type is &'a T. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -260,7 +260,7 @@ impl<T, S> HashSet<T, S> /// of the set in arbitrary order. The set cannot be used after calling /// this. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -286,7 +286,7 @@ impl<T, S> HashSet<T, S> /// Visit the values representing the difference. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -316,7 +316,7 @@ impl<T, S> HashSet<T, S> /// Visit the values representing the symmetric difference. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -342,7 +342,7 @@ impl<T, S> HashSet<T, S> /// Visit the values representing the intersection. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -367,7 +367,7 @@ impl<T, S> HashSet<T, S> /// Visit the values representing the union. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -389,7 +389,7 @@ impl<T, S> HashSet<T, S> /// Return the number of elements in the set /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -404,7 +404,7 @@ impl<T, S> HashSet<T, S> /// Returns true if the set contains no elements /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -430,7 +430,7 @@ impl<T, S> HashSet<T, S> /// Clears the set, removing all values. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -449,7 +449,7 @@ impl<T, S> HashSet<T, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the value type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -468,7 +468,7 @@ impl<T, S> HashSet<T, S> /// Returns `true` if the set has no elements in common with `other`. /// This is equivalent to checking for an empty intersection. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -489,7 +489,7 @@ impl<T, S> HashSet<T, S> /// Returns `true` if the set is a subset of another. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -510,7 +510,7 @@ impl<T, S> HashSet<T, S> /// Returns `true` if the set is a superset of another. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -536,7 +536,7 @@ impl<T, S> HashSet<T, S> /// Adds a value to the set. Returns `true` if the value was not already /// present in the set. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; @@ -557,7 +557,7 @@ impl<T, S> HashSet<T, S> /// `Hash` and `Eq` on the borrowed form *must* match those for /// the value type. /// - /// # Example + /// # Examples /// /// ``` /// use std::collections::HashSet; diff --git a/src/libstd/env.rs b/src/libstd/env.rs index b2ef04a5d63..fb7de8c5f66 100644 --- a/src/libstd/env.rs +++ b/src/libstd/env.rs @@ -38,7 +38,7 @@ use sys::os as os_imp; /// * There are insufficient permissions to access the current directory. /// * The internal buffer is not large enough to hold the path. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -55,7 +55,7 @@ pub fn current_dir() -> io::Result<PathBuf> { /// Changes the current working directory to the specified path, returning /// whether the change was completed successfully or not. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -99,7 +99,7 @@ pub struct VarsOs { inner: os_imp::Env } /// environment is not valid unicode. If this is not desired, consider using the /// `env::vars_os` function. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -122,7 +122,7 @@ pub fn vars() -> Vars { /// variables at the time of this invocation, modifications to environment /// variables afterwards will not be reflected in the returned iterator. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -163,7 +163,7 @@ impl Iterator for VarsOs { /// valid unicode. If the environment variable is not present, or it is not /// valid unicode, then `Err` will be returned. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -185,7 +185,7 @@ pub fn var<K: ?Sized>(key: &K) -> Result<String, VarError> where K: AsOsStr { /// Fetches the environment variable `key` from the current process, returning /// None if the variable isn't set. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -243,7 +243,7 @@ impl Error for VarError { /// Sets the environment variable `k` to the value `v` for the currently running /// process. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -279,7 +279,7 @@ pub struct SplitPaths<'a> { inner: os_imp::SplitPaths<'a> } /// /// Returns an iterator over the paths contained in `unparsed`. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -323,7 +323,7 @@ pub struct JoinPathsError { /// `Path`s contains an invalid character for constructing the `PATH` /// variable (a double quote on Windows or a colon on Unix). /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -371,7 +371,7 @@ impl Error for JoinPathsError { /// 'USERPROFILE' environment variable if it is set and not equal to the empty /// string. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -478,7 +478,7 @@ pub struct ArgsOs { inner: os_imp::Args } /// process is not valid unicode. If this is not desired it is recommended to /// use the `args_os` function instead. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; @@ -500,7 +500,7 @@ pub fn args() -> Args { /// set to arbitrary text, and it may not even exist, so this property should /// not be relied upon for security purposes. /// -/// # Example +/// # Examples /// /// ```rust /// use std::env; diff --git a/src/libstd/ffi/c_str.rs b/src/libstd/ffi/c_str.rs index ec9f90723be..44564ebf53d 100644 --- a/src/libstd/ffi/c_str.rs +++ b/src/libstd/ffi/c_str.rs @@ -41,7 +41,7 @@ use vec::Vec; /// a `CString` do *not* contain the trailing nul terminator unless otherwise /// specified. /// -/// # Example +/// # Examples /// /// ```no_run /// # extern crate libc; @@ -325,7 +325,7 @@ impl CStr { /// > currently implemented with an up-front calculation of the length of /// > the string. This is not guaranteed to always be the case. /// - /// # Example + /// # Examples /// /// ```no_run /// # extern crate libc; diff --git a/src/libstd/fs/mod.rs b/src/libstd/fs/mod.rs index 9f9163eb9e6..0faae7015a6 100644 --- a/src/libstd/fs/mod.rs +++ b/src/libstd/fs/mod.rs @@ -36,7 +36,7 @@ mod tempdir; /// it was opened with. Files also implement `Seek` to alter the logical cursor /// that the file contains internally. /// -/// # Example +/// # Examples /// /// ```no_run /// use std::io::prelude::*; @@ -392,7 +392,7 @@ impl DirEntry { /// Remove a file from the underlying filesystem. /// -/// # Example +/// # Examples /// /// ```rust,no_run /// use std::fs; @@ -420,7 +420,7 @@ pub fn remove_file<P: AsPath + ?Sized>(path: &P) -> io::Result<()> { /// This function will traverse soft links to query information about the /// destination file. /// -/// # Example +/// # Examples /// /// ```rust,no_run /// # fn foo() -> std::io::Result<()> { @@ -444,7 +444,7 @@ pub fn metadata<P: AsPath + ?Sized>(path: &P) -> io::Result<Metadata> { /// Rename a file or directory to a new name. /// -/// # Example +/// # Examples /// /// ```rust,no_run /// use std::fs; @@ -472,7 +472,7 @@ pub fn rename<P: AsPath + ?Sized, Q: AsPath + ?Sized>(from: &P, to: &Q) /// Note that if `from` and `to` both point to the same file, then the file /// will likely get truncated by this operation. /// -/// # Example +/// # Examples /// /// ```rust /// use std::fs; @@ -541,7 +541,7 @@ pub fn read_link<P: AsPath + ?Sized>(path: &P) -> io::Result<PathBuf> { /// Create a new, empty directory at the provided path /// -/// # Example +/// # Examples /// /// ```rust /// use std::fs; @@ -587,7 +587,7 @@ pub fn create_dir_all<P: AsPath + ?Sized>(path: &P) -> io::Result<()> { /// Remove an existing, empty directory /// -/// # Example +/// # Examples /// /// ```rust /// use std::fs; @@ -638,7 +638,7 @@ pub fn remove_dir_all<P: AsPath + ?Sized>(path: &P) -> io::Result<()> { /// The iterator will yield instances of `io::Result<DirEntry>`. New errors may /// be encountered after an iterator is initially constructed. /// -/// # Example +/// # Examples /// /// ```rust /// use std::io; @@ -776,7 +776,7 @@ pub fn set_file_times<P: AsPath + ?Sized>(path: &P, accessed: u64, /// Changes the permissions found on a file or a directory. /// -/// # Example +/// # Examples /// /// ``` /// # fn foo() -> std::io::Result<()> { diff --git a/src/libstd/macros.rs b/src/libstd/macros.rs index abdcca59c58..a5022943267 100644 --- a/src/libstd/macros.rs +++ b/src/libstd/macros.rs @@ -26,7 +26,7 @@ /// The multi-argument form of this macro panics with a string and has the /// `format!` syntax for building a string. /// -/// # Example +/// # Examples /// /// ```should_fail /// # #![allow(unreachable_code)] @@ -74,7 +74,7 @@ macro_rules! print { /// The syntax of this macro is the same as that used for `format!`. For more /// information, see `std::fmt` and `std::old_io::stdio`. /// -/// # Example +/// # Examples /// /// ``` /// println!("hello there!"); @@ -177,7 +177,7 @@ pub mod builtin { /// /// For more information, see the documentation in `std::fmt`. /// - /// # Example + /// # Examples /// /// ```rust /// use std::fmt; @@ -200,7 +200,7 @@ pub mod builtin { /// will be emitted. To not emit a compile error, use the `option_env!` /// macro instead. /// - /// # Example + /// # Examples /// /// ```rust /// let path: &'static str = env!("PATH"); @@ -219,7 +219,7 @@ pub mod builtin { /// A compile time error is never emitted when using this macro regardless /// of whether the environment variable is present or not. /// - /// # Example + /// # Examples /// /// ```rust /// let key: Option<&'static str> = option_env!("SECRET_KEY"); @@ -263,7 +263,7 @@ pub mod builtin { /// Integer and floating point literals are stringified in order to be /// concatenated. /// - /// # Example + /// # Examples /// /// ``` /// let s = concat!("test", 10, 'b', true); @@ -278,7 +278,7 @@ pub mod builtin { /// the invocation of the `line!()` macro itself, but rather the first macro /// invocation leading up to the invocation of the `line!()` macro. /// - /// # Example + /// # Examples /// /// ``` /// let current_line = line!(); @@ -293,7 +293,7 @@ pub mod builtin { /// the invocation of the `column!()` macro itself, but rather the first macro /// invocation leading up to the invocation of the `column!()` macro. /// - /// # Example + /// # Examples /// /// ``` /// let current_col = column!(); @@ -309,7 +309,7 @@ pub mod builtin { /// first macro invocation leading up to the invocation of the `file!()` /// macro. /// - /// # Example + /// # Examples /// /// ``` /// let this_file = file!(); @@ -324,7 +324,7 @@ pub mod builtin { /// stringification of all the tokens passed to the macro. No restrictions /// are placed on the syntax of the macro invocation itself. /// - /// # Example + /// # Examples /// /// ``` /// let one_plus_one = stringify!(1 + 1); @@ -339,7 +339,7 @@ pub mod builtin { /// contents of the filename specified. The file is located relative to the /// current file (similarly to how modules are found), /// - /// # Example + /// # Examples /// /// ```rust,ignore /// let secret_key = include_str!("secret-key.ascii"); @@ -353,7 +353,7 @@ pub mod builtin { /// the contents of the filename specified. The file is located relative to /// the current file (similarly to how modules are found), /// - /// # Example + /// # Examples /// /// ```rust,ignore /// let secret_key = include_bytes!("secret-key.bin"); @@ -367,7 +367,7 @@ pub mod builtin { /// leading back up to the crate root. The first component of the path /// returned is the name of the crate currently being compiled. /// - /// # Example + /// # Examples /// /// ```rust /// mod test { @@ -390,7 +390,7 @@ pub mod builtin { /// The syntax given to this macro is the same syntax as the `cfg` /// attribute. /// - /// # Example + /// # Examples /// /// ```rust /// let my_directory = if cfg!(windows) { diff --git a/src/libstd/net/mod.rs b/src/libstd/net/mod.rs index d73c06a2549..b8cb8cb5289 100644 --- a/src/libstd/net/mod.rs +++ b/src/libstd/net/mod.rs @@ -82,7 +82,7 @@ impl Iterator for LookupHost { /// This method may perform a DNS query to resolve `host` and may also inspect /// system configuration to resolve the specified hostname. /// -/// # Example +/// # Examples /// /// ```no_run /// use std::net; diff --git a/src/libstd/net/tcp.rs b/src/libstd/net/tcp.rs index fd723ea13e9..76c04835473 100644 --- a/src/libstd/net/tcp.rs +++ b/src/libstd/net/tcp.rs @@ -21,7 +21,7 @@ use sys_common::AsInner; /// /// The socket will be closed when the value is dropped. /// -/// # Example +/// # Examples /// /// ```no_run /// use std::io::prelude::*; diff --git a/src/libstd/net/udp.rs b/src/libstd/net/udp.rs index 92f00599826..041e6551ff5 100644 --- a/src/libstd/net/udp.rs +++ b/src/libstd/net/udp.rs @@ -21,7 +21,7 @@ use sys_common::AsInner; /// IPv6 addresses, and there is no corresponding notion of a server because UDP /// is a datagram protocol. /// -/// # Example +/// # Examples /// /// ```no_run /// use std::net::UdpSocket; diff --git a/src/libstd/old_io/buffered.rs b/src/libstd/old_io/buffered.rs index cbb7bf04327..3ee73f5ff60 100644 --- a/src/libstd/old_io/buffered.rs +++ b/src/libstd/old_io/buffered.rs @@ -31,7 +31,7 @@ use vec::Vec; /// `BufferedReader` performs large, infrequent reads on the underlying /// `Reader` and maintains an in-memory buffer of the results. /// -/// # Example +/// # Examples /// /// ```rust /// use std::old_io::{BufferedReader, File}; @@ -134,7 +134,7 @@ impl<R: Reader> Reader for BufferedReader<R> { /// /// This writer will be flushed when it is dropped. /// -/// # Example +/// # Examples /// /// ```rust /// use std::old_io::{BufferedWriter, File}; @@ -320,7 +320,7 @@ impl<W: Reader> Reader for InternalBufferedWriter<W> { /// /// The output half will be flushed when this stream is dropped. /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/comm_adapters.rs b/src/libstd/old_io/comm_adapters.rs index dec1ae98ba0..72ba653a986 100644 --- a/src/libstd/old_io/comm_adapters.rs +++ b/src/libstd/old_io/comm_adapters.rs @@ -20,7 +20,7 @@ use vec::Vec; /// Allows reading from a rx. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::mpsc::channel; @@ -111,7 +111,7 @@ impl Reader for ChanReader { /// Allows writing to a tx. /// -/// # Example +/// # Examples /// /// ``` /// # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/fs.rs b/src/libstd/old_io/fs.rs index afffed2278b..b0116bd4efd 100644 --- a/src/libstd/old_io/fs.rs +++ b/src/libstd/old_io/fs.rs @@ -27,7 +27,7 @@ //! the metadata of a file. This includes getting the `stat` information, //! reading off particular bits of it, etc. //! -//! # Example +//! # Examples //! //! ```rust //! # #![allow(unused_must_use)] @@ -102,7 +102,7 @@ impl File { /// Open a file at `path` in the mode specified by the `mode` and `access` /// arguments /// - /// # Example + /// # Examples /// /// ```rust,should_fail /// use std::old_io::{File, Open, ReadWrite}; @@ -173,7 +173,7 @@ impl File { /// /// For more information, see the `File::open_mode` function. /// - /// # Example + /// # Examples /// /// ```rust /// use std::old_io::File; @@ -192,7 +192,7 @@ impl File { /// /// For more information, see the `File::open_mode` function. /// - /// # Example + /// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -283,7 +283,7 @@ impl File { /// Unlink a file from the underlying filesystem. /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -314,7 +314,7 @@ pub fn unlink(path: &Path) -> IoResult<()> { /// directory, etc. This function will traverse symlinks to query /// information about the destination file. /// -/// # Example +/// # Examples /// /// ```rust /// use std::old_io::fs; @@ -356,7 +356,7 @@ pub fn lstat(path: &Path) -> IoResult<FileStat> { /// Rename a file or directory to a new name. /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -384,7 +384,7 @@ pub fn rename(from: &Path, to: &Path) -> IoResult<()> { /// Note that if `from` and `to` both point to the same file, then the file /// will likely get truncated by this operation. /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -434,7 +434,7 @@ pub fn copy(from: &Path, to: &Path) -> IoResult<()> { /// Changes the permission mode bits found on a file or a directory. This /// function takes a mask from the `io` module /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -505,7 +505,7 @@ pub fn readlink(path: &Path) -> IoResult<Path> { /// Create a new, empty directory at the provided path /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -529,7 +529,7 @@ pub fn mkdir(path: &Path, mode: FilePermission) -> IoResult<()> { /// Remove an existing, empty directory /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -553,7 +553,7 @@ pub fn rmdir(path: &Path) -> IoResult<()> { /// Retrieve a vector containing all entries within a provided directory /// -/// # Example +/// # Examples /// /// ```rust /// use std::old_io::fs::PathExtensions; diff --git a/src/libstd/old_io/mem.rs b/src/libstd/old_io/mem.rs index e6a8b90ea33..2445da9ea3b 100644 --- a/src/libstd/old_io/mem.rs +++ b/src/libstd/old_io/mem.rs @@ -51,7 +51,7 @@ impl Writer for Vec<u8> { /// Writes to an owned, growable byte vector /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -111,7 +111,7 @@ impl Writer for MemWriter { /// Reads from an owned byte vector /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -241,7 +241,7 @@ impl<'a> Buffer for &'a [u8] { /// If a write will not fit in the buffer, it returns an error and does not /// write any data. /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -313,7 +313,7 @@ impl<'a> Seek for BufWriter<'a> { /// Reads from a fixed-size byte slice /// -/// # Example +/// # Examples /// /// ```rust /// # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/mod.rs b/src/libstd/old_io/mod.rs index f2042b384ce..f71698fa725 100644 --- a/src/libstd/old_io/mod.rs +++ b/src/libstd/old_io/mod.rs @@ -1276,7 +1276,7 @@ impl<'a> Writer for &'a mut (Writer+'a) { /// A `RefWriter` is a struct implementing `Writer` which contains a reference /// to another writer. This is often useful when composing streams. /// -/// # Example +/// # Examples /// /// ``` /// use std::old_io::util::TeeReader; @@ -1401,7 +1401,7 @@ pub trait Buffer: Reader { /// encoded Unicode codepoints. If a newline is encountered, then the /// newline is contained in the returned string. /// - /// # Example + /// # Examples /// /// ```rust /// use std::old_io::BufReader; @@ -1625,7 +1625,7 @@ impl<'a, T, A: ?Sized + Acceptor<T>> Iterator for IncomingConnections<'a, A> { /// Creates a standard error for a commonly used flavor of error. The `detail` /// field of the returned error will always be `None`. /// -/// # Example +/// # Examples /// /// ``` /// use std::old_io as io; diff --git a/src/libstd/old_io/net/pipe.rs b/src/libstd/old_io/net/pipe.rs index 2ecaf515f08..59352532902 100644 --- a/src/libstd/old_io/net/pipe.rs +++ b/src/libstd/old_io/net/pipe.rs @@ -50,7 +50,7 @@ impl UnixStream { /// /// The returned stream will be closed when the object falls out of scope. /// - /// # Example + /// # Examples /// /// ```rust /// # #![allow(unused_must_use)] @@ -175,7 +175,7 @@ impl UnixListener { /// /// This listener will be closed when it falls out of scope. /// - /// # Example + /// # Examples /// /// ``` /// # fn foo() { diff --git a/src/libstd/old_io/net/tcp.rs b/src/libstd/old_io/net/tcp.rs index 73ef21fa3aa..6fb8020a3d6 100644 --- a/src/libstd/old_io/net/tcp.rs +++ b/src/libstd/old_io/net/tcp.rs @@ -38,7 +38,7 @@ use sys_common; /// /// The socket will be closed when the value is dropped. /// -/// # Example +/// # Examples /// /// ```no_run /// use std::old_io::TcpStream; @@ -130,7 +130,7 @@ impl TcpStream { /// This method will close the reading portion of this connection, causing /// all pending and future reads to immediately return with an error. /// - /// # Example + /// # Examples /// /// ```no_run /// # #![allow(unused_must_use)] @@ -373,7 +373,7 @@ impl TcpAcceptor { /// regardless of whether the timeout has expired or not (the accept will /// not block in this case). /// - /// # Example + /// # Examples /// /// ```no_run /// use std::old_io::TcpListener; @@ -417,7 +417,7 @@ impl TcpAcceptor { /// This is useful for waking up a thread in an accept loop to indicate that /// it should exit. /// - /// # Example + /// # Examples /// /// ``` /// use std::old_io::{TcpListener, Listener, Acceptor, EndOfFile}; diff --git a/src/libstd/old_io/net/udp.rs b/src/libstd/old_io/net/udp.rs index 67b57b25086..97ef3da2f36 100644 --- a/src/libstd/old_io/net/udp.rs +++ b/src/libstd/old_io/net/udp.rs @@ -28,7 +28,7 @@ use sys_common; /// IPv6 addresses, and there is no corresponding notion of a server because UDP /// is a datagram protocol. /// -/// # Example +/// # Examples /// /// ```rust,no_run /// # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/pipe.rs b/src/libstd/old_io/pipe.rs index b7b626db034..b78c8acb190 100644 --- a/src/libstd/old_io/pipe.rs +++ b/src/libstd/old_io/pipe.rs @@ -43,7 +43,7 @@ impl PipeStream { /// This operation consumes ownership of the file descriptor and it will be /// closed once the object is deallocated. /// - /// # Example + /// # Examples /// /// ```{rust,no_run} /// # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/process.rs b/src/libstd/old_io/process.rs index a30dcd9d9f0..cabba8e358a 100644 --- a/src/libstd/old_io/process.rs +++ b/src/libstd/old_io/process.rs @@ -57,7 +57,7 @@ use thread; /// process is created via the `Command` struct, which configures the spawning /// process and can itself be constructed using a builder-style interface. /// -/// # Example +/// # Examples /// /// ```should_fail /// use std::old_io::Command; @@ -361,7 +361,7 @@ impl Command { /// Executes the command as a child process, waiting for it to finish and /// collecting all of its output. /// - /// # Example + /// # Examples /// /// ``` /// use std::old_io::Command; @@ -382,7 +382,7 @@ impl Command { /// Executes a command as a child process, waiting for it to finish and /// collecting its exit status. /// - /// # Example + /// # Examples /// /// ``` /// use std::old_io::Command; @@ -656,7 +656,7 @@ impl Process { /// A value of `None` will clear any previous timeout, and a value of `Some` /// will override any previously set timeout. /// - /// # Example + /// # Examples /// /// ```no_run /// use std::old_io::{Command, IoResult}; diff --git a/src/libstd/old_io/stdio.rs b/src/libstd/old_io/stdio.rs index 85bf4908f83..70e8a4ceff0 100644 --- a/src/libstd/old_io/stdio.rs +++ b/src/libstd/old_io/stdio.rs @@ -15,7 +15,7 @@ //! inspected for information about terminal dimensions or for related information //! about the stream or terminal to which it is attached. //! -//! # Example +//! # Examples //! //! ```rust //! # #![allow(unused_must_use)] diff --git a/src/libstd/old_io/timer.rs b/src/libstd/old_io/timer.rs index 375fe6ce483..de7883c715a 100644 --- a/src/libstd/old_io/timer.rs +++ b/src/libstd/old_io/timer.rs @@ -113,7 +113,7 @@ impl Timer { /// invalidated at the end of that statement, and all `recv` calls will /// fail. /// - /// # Example + /// # Examples /// /// ```rust /// use std::old_io::Timer; @@ -165,7 +165,7 @@ impl Timer { /// invalidated at the end of that statement, and all `recv` calls will /// fail. /// - /// # Example + /// # Examples /// /// ```rust /// use std::old_io::Timer; diff --git a/src/libstd/old_path/mod.rs b/src/libstd/old_path/mod.rs index 4f8976fb2ec..7551e91178c 100644 --- a/src/libstd/old_path/mod.rs +++ b/src/libstd/old_path/mod.rs @@ -46,7 +46,7 @@ //! suitable for passing to any API that actually operates on the path; it is only intended for //! display. //! -//! ## Example +//! ## Examples //! //! ```rust //! use std::old_io::fs::PathExtensions; @@ -140,7 +140,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Creates a new Path from a byte vector or string. /// The resulting Path will always be normalized. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -164,7 +164,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Creates a new Path from a byte vector or string, if possible. /// The resulting Path will always be normalized. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -186,7 +186,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the path as a string, if possible. /// If the path is not representable in utf-8, this returns None. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -203,7 +203,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the path as a byte vector /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -217,7 +217,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Converts the Path into an owned byte vector /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -232,7 +232,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns an object that implements `Display` for printing paths /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -250,7 +250,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// /// If there is no filename, nothing will be printed. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -267,7 +267,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the directory component of `self`, as a byte vector (with no trailing separator). /// If `self` has no directory component, returns ['.']. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -282,7 +282,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the directory component of `self`, as a string, if possible. /// See `dirname` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -301,7 +301,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// If `self` represents the root of the file hierarchy, returns None. /// If `self` is "." or "..", returns None. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -316,7 +316,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the file component of `self`, as a string, if possible. /// See `filename` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -335,7 +335,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// The stem is the portion of the filename just before the last '.'. /// If there is no '.', the entire filename is returned. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -362,7 +362,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the stem of the filename of `self`, as a string, if possible. /// See `filestem` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -382,7 +382,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// If there is no extension, None is returned. /// If the filename ends in '.', the empty vector is returned. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -409,7 +409,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the extension of the filename of `self`, as a string, if possible. /// See `extension` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -427,7 +427,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Replaces the filename portion of the path with the given byte vector or string. /// If the replacement name is [], this is equivalent to popping the path. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -453,7 +453,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// If the argument is [] or "", this removes the extension. /// If `self` has no filename, this is a no-op. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -503,7 +503,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// byte vector or string. /// See `set_filename` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -528,7 +528,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// byte vector or string. /// See `set_extension` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -552,7 +552,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns the directory component of `self`, as a Path. /// If `self` represents the root of the filesystem hierarchy, returns `self`. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -571,7 +571,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// /// If `self` is not absolute, or vol/cwd-relative in the case of Windows, this returns None. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -586,7 +586,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Pushes a path (as a byte vector or string) onto `self`. /// If the argument represents an absolute path, it replaces `self`. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -610,7 +610,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Pushes multiple paths (as byte vectors or strings) onto `self`. /// See `push` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -639,7 +639,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns `true` if the receiver was modified, or `false` if it already /// represented the root of the file hierarchy. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -656,7 +656,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// (as a byte vector or string). /// If the given path is absolute, the new Path will represent just that. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -681,7 +681,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// (as byte vectors or strings). /// See `join` for details. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -703,7 +703,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// An absolute path is defined as one that, when joined to another path, will /// yield back the same absolute path. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -720,7 +720,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// But for Windows paths, it also means the path is not volume-relative or /// relative to the current working directory. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -738,7 +738,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// If both paths are relative, they are compared as though they are relative /// to the same parent path. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -757,7 +757,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// If `self` is absolute and `base` is relative, or on Windows if both /// paths refer to separate drives, an absolute path is returned. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); @@ -773,7 +773,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe { /// Returns whether the relative path `child` is a suffix of `self`. /// - /// # Example + /// # Examples /// /// ``` /// # foo(); diff --git a/src/libstd/old_path/windows.rs b/src/libstd/old_path/windows.rs index 5f2f1728be1..838710b1aec 100644 --- a/src/libstd/old_path/windows.rs +++ b/src/libstd/old_path/windows.rs @@ -603,7 +603,7 @@ impl Path { /// /// Panics if the vector contains a `NUL`, or if it contains invalid UTF-8. /// - /// # Example + /// # Examples /// /// ``` /// println!("{}", Path::new(r"C:\some\path").display()); @@ -617,7 +617,7 @@ impl Path { /// /// Returns `None` if the vector contains a `NUL`, or if it contains invalid UTF-8. /// - /// # Example + /// # Examples /// /// ``` /// let path = Path::new_opt(r"C:\some\path"); diff --git a/src/libstd/os.rs b/src/libstd/os.rs index 9c42d1be77e..f81377e8084 100644 --- a/src/libstd/os.rs +++ b/src/libstd/os.rs @@ -121,7 +121,7 @@ pub const TMPBUF_SZ : uint = 1000; /// * There are insufficient permissions to access the current directory. /// * The internal buffer is not large enough to hold the path. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -141,7 +141,7 @@ pub fn getcwd() -> IoResult<Path> { /// Invalid UTF-8 bytes are replaced with \uFFFD. See `String::from_utf8_lossy()` /// for details. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -177,7 +177,7 @@ pub fn env_as_bytes() -> Vec<(Vec<u8>, Vec<u8>)> { /// /// Panics if `n` has any interior NULs. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -219,7 +219,7 @@ fn byteify(s: OsString) -> Vec<u8> { /// Sets the environment variable `n` to the value `v` for the currently running /// process. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -260,7 +260,7 @@ pub fn unsetenv(n: &str) { /// Parses input according to platform conventions for the `PATH` /// environment variable. /// -/// # Example +/// # Examples /// ```rust /// use std::os; /// @@ -291,7 +291,7 @@ pub fn split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> { /// `Path`s contains an invalid character for constructing the `PATH` /// variable (a double quote on Windows or a colon on Unix). /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -372,7 +372,7 @@ pub fn self_exe_name() -> Option<Path> { /// /// Like self_exe_name() but without the binary's name. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -401,7 +401,7 @@ pub fn self_exe_path() -> Option<Path> { /// 'USERPROFILE' environment variable if it is set and not equal to the empty /// string. /// -/// # Example +/// # Examples /// /// ```rust /// use std::os; @@ -491,7 +491,7 @@ pub fn tmpdir() -> Path { /// directory. If the given path is already an absolute path, return it /// as is. /// -/// # Example +/// # Examples /// ```rust /// use std::os; /// use std::old_path::Path; @@ -522,7 +522,7 @@ pub fn make_absolute(p: &Path) -> IoResult<Path> { /// Changes the current working directory to the specified path, returning /// whether the change was completed successfully or not. /// -/// # Example +/// # Examples /// ```rust /// use std::os; /// use std::old_path::Path; @@ -543,7 +543,7 @@ pub fn errno() -> i32 { /// Return the string corresponding to an `errno()` value of `errnum`. /// -/// # Example +/// # Examples /// ```rust /// use std::os; /// @@ -739,7 +739,7 @@ extern "system" { /// /// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD. /// See `String::from_utf8_lossy` for details. -/// # Example +/// # Examples /// /// ```rust /// use std::os; diff --git a/src/libstd/path.rs b/src/libstd/path.rs index ad8e17fed24..bf71acc522c 100644 --- a/src/libstd/path.rs +++ b/src/libstd/path.rs @@ -809,7 +809,7 @@ impl<'a> cmp::Ord for Components<'a> { /// More details about the overall approach can be found in /// the module documentation. /// -/// # Example +/// # Examples /// /// ```rust /// use std::path::PathBuf; @@ -1041,7 +1041,7 @@ impl AsOsStr for PathBuf { /// This is an *unsized* type, meaning that it must always be used with behind a /// pointer like `&` or `Box`. /// -/// # Example +/// # Examples /// /// ```rust /// use std::path::Path; diff --git a/src/libstd/process.rs b/src/libstd/process.rs index ec4fcec5556..ebd0820669c 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -35,7 +35,7 @@ use thread; /// process is created via the `Command` struct, which configures the spawning /// process and can itself be constructed using a builder-style interface. /// -/// # Example +/// # Examples /// /// ```should_fail /// # #![feature(process)] @@ -288,7 +288,7 @@ impl Command { /// /// By default, stdin, stdout and stderr are inherited by the parent. /// - /// # Example + /// # Examples /// /// ``` /// # #![feature(process)] diff --git a/src/libstd/rand/mod.rs b/src/libstd/rand/mod.rs index 7382cc6e2eb..e8407ab1115 100644 --- a/src/libstd/rand/mod.rs +++ b/src/libstd/rand/mod.rs @@ -424,7 +424,7 @@ pub fn random<T: Rand>() -> T { /// Randomly sample up to `amount` elements from an iterator. /// -/// # Example +/// # Examples /// /// ```rust /// use std::rand::{thread_rng, sample}; diff --git a/src/libstd/rand/reader.rs b/src/libstd/rand/reader.rs index c56dc387b7f..08c43198aa1 100644 --- a/src/libstd/rand/reader.rs +++ b/src/libstd/rand/reader.rs @@ -22,7 +22,7 @@ use slice::SliceExt; /// /// It will panic if it there is insufficient data to fulfill a request. /// -/// # Example +/// # Examples /// /// ```rust /// use std::rand::{reader, Rng}; diff --git a/src/libstd/sync/condvar.rs b/src/libstd/sync/condvar.rs index 3499675f542..4430cc3b0af 100644 --- a/src/libstd/sync/condvar.rs +++ b/src/libstd/sync/condvar.rs @@ -34,7 +34,7 @@ use sync::{mutex, MutexGuard, PoisonError}; /// in a runtime panic. If this is not desired, then the unsafe primitives in /// `sys` do not have this restriction but may result in undefined behavior. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::{Arc, Mutex, Condvar}; @@ -66,7 +66,7 @@ pub struct Condvar { inner: Box<StaticCondvar> } /// This structure is identical to `Condvar` except that it is suitable for use /// in static initializers for other structures. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::{StaticCondvar, CONDVAR_INIT}; diff --git a/src/libstd/sync/mpsc/mod.rs b/src/libstd/sync/mpsc/mod.rs index 2ae1d4a9d50..01eeed4fb54 100644 --- a/src/libstd/sync/mpsc/mod.rs +++ b/src/libstd/sync/mpsc/mod.rs @@ -464,7 +464,7 @@ impl<T> UnsafeFlavor<T> for Receiver<T> { /// All data sent on the sender will become available on the receiver, and no /// send will block the calling task (this channel has an "infinite buffer"). /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::mpsc::channel; @@ -506,7 +506,7 @@ pub fn channel<T: Send>() -> (Sender<T>, Receiver<T>) { /// As with asynchronous channels, all senders will panic in `send` if the /// `Receiver` has been destroyed. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::mpsc::sync_channel; @@ -555,7 +555,7 @@ impl<T: Send> Sender<T> { /// /// This method will never block the current thread. /// - /// # Example + /// # Examples /// /// ``` /// use std::sync::mpsc::channel; diff --git a/src/libstd/sync/mpsc/select.rs b/src/libstd/sync/mpsc/select.rs index 2c14c9fe3f1..b5739c36aa9 100644 --- a/src/libstd/sync/mpsc/select.rs +++ b/src/libstd/sync/mpsc/select.rs @@ -24,7 +24,7 @@ //! received values of receivers in a much more natural syntax then usage of the //! `Select` structure directly. //! -//! # Example +//! # Examples //! //! ```rust //! use std::sync::mpsc::channel; diff --git a/src/libstd/sync/mutex.rs b/src/libstd/sync/mutex.rs index 6f0febd61e8..41378a6b312 100644 --- a/src/libstd/sync/mutex.rs +++ b/src/libstd/sync/mutex.rs @@ -133,7 +133,7 @@ unsafe impl<T: Send> Sync for Mutex<T> { } /// to a `Mutex`, a `destroy` method. This method is unsafe to call, and /// documentation can be found directly on the method. /// -/// # Example +/// # Examples /// /// ```rust /// use std::sync::{StaticMutex, MUTEX_INIT}; diff --git a/src/libstd/sync/once.rs b/src/libstd/sync/once.rs index d2054a1e819..5cad2916624 100644 --- a/src/libstd/sync/once.rs +++ b/src/libstd/sync/once.rs @@ -24,7 +24,7 @@ use sync::{StaticMutex, MUTEX_INIT}; /// functionality. This type can only be constructed with the `ONCE_INIT` /// value. /// -/// # Example +/// # Examples /// /// ```rust /// use std::sync::{Once, ONCE_INIT}; diff --git a/src/libstd/sync/rwlock.rs b/src/libstd/sync/rwlock.rs index e9ff6c0bf9d..368e88e4e8b 100644 --- a/src/libstd/sync/rwlock.rs +++ b/src/libstd/sync/rwlock.rs @@ -74,7 +74,7 @@ unsafe impl<T: Send + Sync> Sync for RwLock<T> {} /// automatic global access as well as lazy initialization. The internal /// resources of this RwLock, however, must be manually deallocated. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::{StaticRwLock, RW_LOCK_INIT}; diff --git a/src/libstd/sync/semaphore.rs b/src/libstd/sync/semaphore.rs index 410e1c11bb9..2f9873950b6 100644 --- a/src/libstd/sync/semaphore.rs +++ b/src/libstd/sync/semaphore.rs @@ -22,7 +22,7 @@ use sync::{Mutex, Condvar}; /// until the counter is positive, and each release will increment the counter /// and unblock any threads if necessary. /// -/// # Example +/// # Examples /// /// ``` /// use std::sync::Semaphore; diff --git a/src/libstd/sync/task_pool.rs b/src/libstd/sync/task_pool.rs index e41bc6d8683..3d31790550b 100644 --- a/src/libstd/sync/task_pool.rs +++ b/src/libstd/sync/task_pool.rs @@ -58,7 +58,7 @@ impl<'a> Drop for Sentinel<'a> { /// Spawns `n` worker threads and replenishes the pool if any worker threads /// panic. /// -/// # Example +/// # Examples /// /// ```rust /// use std::sync::TaskPool; diff --git a/src/libstd/sys/common/thread_local.rs b/src/libstd/sys/common/thread_local.rs index 91de2662883..27936241639 100644 --- a/src/libstd/sys/common/thread_local.rs +++ b/src/libstd/sys/common/thread_local.rs @@ -28,7 +28,7 @@ //! more useful in practice than this OS-based version which likely requires //! unsafe code to interoperate with. //! -//! # Example +//! # Examples //! //! Using a dynamically allocated TLS key. Note that this key can be shared //! among many threads via an `Arc`. @@ -73,7 +73,7 @@ use sys::thread_local as imp; /// time. The key is also deallocated when the Rust runtime exits or `destroy` /// is called, whichever comes first. /// -/// # Example +/// # Examples /// /// ```ignore /// use tls::os::{StaticKey, INIT}; @@ -110,7 +110,7 @@ pub struct StaticKeyInner { /// Implementations will likely, however, contain unsafe code as this type only /// operates on `*mut u8`, an unsafe pointer. /// -/// # Example +/// # Examples /// /// ```rust,ignore /// use tls::os::Key; diff --git a/src/libstd/sys/windows/c.rs b/src/libstd/sys/windows/c.rs index 8ed7302b665..b9be4eb6bf5 100644 --- a/src/libstd/sys/windows/c.rs +++ b/src/libstd/sys/windows/c.rs @@ -300,7 +300,7 @@ pub mod compat { /// Macro for creating a compatibility fallback for a Windows function /// - /// # Example + /// # Examples /// ``` /// compat_fn!(adll32::SomeFunctionW(_arg: LPCWSTR) { /// // Fallback implementation diff --git a/src/libstd/thread_local/mod.rs b/src/libstd/thread_local/mod.rs index 6bba73420d8..08780292c88 100644 --- a/src/libstd/thread_local/mod.rs +++ b/src/libstd/thread_local/mod.rs @@ -68,7 +68,7 @@ pub mod __impl { /// within a thread, and values support destructors which will be run when a /// thread exits. /// -/// # Example +/// # Examples /// /// ``` /// use std::cell::RefCell; diff --git a/src/libstd/thread_local/scoped.rs b/src/libstd/thread_local/scoped.rs index a5339568e9e..86e6c059a70 100644 --- a/src/libstd/thread_local/scoped.rs +++ b/src/libstd/thread_local/scoped.rs @@ -21,7 +21,7 @@ //! period of time and it is not required to relinquish ownership of the //! contents. //! -//! # Example +//! # Examples //! //! ``` //! scoped_thread_local!(static FOO: u32); @@ -139,7 +139,7 @@ impl<T> Key<T> { /// Upon return, this function will restore the previous value, if any /// was available. /// - /// # Example + /// # Examples /// /// ``` /// scoped_thread_local!(static FOO: u32); @@ -191,7 +191,7 @@ impl<T> Key<T> { /// /// This function will panic if `set` has not previously been called. /// - /// # Example + /// # Examples /// /// ```no_run /// scoped_thread_local!(static FOO: u32); |