1
Fork 0

docs: Standardize on 'Errors' header in std docs

This commit is contained in:
Kamal Marhubi 2016-02-01 21:41:29 -05:00
parent 49fe519791
commit 129a6239d2
9 changed files with 18 additions and 18 deletions

View file

@ -1644,7 +1644,7 @@ impl str {
/// ///
/// [`FromStr`]: str/trait.FromStr.html /// [`FromStr`]: str/trait.FromStr.html
/// ///
/// # Failure /// # Errors
/// ///
/// Will return `Err` if it's not possible to parse this string slice into /// Will return `Err` if it's not possible to parse this string slice into
/// the desired type. /// the desired type.

View file

@ -433,7 +433,7 @@ impl String {
/// ///
/// [`str::from_utf8()`]: ../str/fn.from_utf8.html /// [`str::from_utf8()`]: ../str/fn.from_utf8.html
/// ///
/// # Failure /// # Errors
/// ///
/// Returns `Err` if the slice is not UTF-8 with a description as to why the /// Returns `Err` if the slice is not UTF-8 with a description as to why the
/// provided bytes are not UTF-8. The vector you moved in is also included. /// provided bytes are not UTF-8. The vector you moved in is also included.

View file

@ -188,7 +188,7 @@ impl Utf8Error {
/// it, this function is one way to have a stack-allocated string. There is /// it, this function is one way to have a stack-allocated string. There is
/// an example of this in the examples section below. /// an example of this in the examples section below.
/// ///
/// # Failure /// # Errors
/// ///
/// Returns `Err` if the slice is not UTF-8 with a description as to why the /// Returns `Err` if the slice is not UTF-8 with a description as to why the
/// provided slice is not UTF-8. /// provided slice is not UTF-8.

View file

@ -194,7 +194,7 @@ impl char {
/// * `a-z` /// * `a-z`
/// * `A-Z` /// * `A-Z`
/// ///
/// # Failure /// # Errors
/// ///
/// Returns `None` if the `char` does not refer to a digit in the given radix. /// Returns `None` if the `char` does not refer to a digit in the given radix.
/// ///

View file

@ -70,7 +70,7 @@ pub struct Metadata(fs_imp::FileAttr);
/// information like the entry's path and possibly other metadata can be /// information like the entry's path and possibly other metadata can be
/// learned. /// learned.
/// ///
/// # Failure /// # Errors
/// ///
/// This `io::Result` will be an `Err` if there's some sort of intermittent /// This `io::Result` will be an `Err` if there's some sort of intermittent
/// IO error during iteration. /// IO error during iteration.

View file

@ -129,7 +129,7 @@ impl Condvar {
/// the predicate must always be checked each time this function returns to /// the predicate must always be checked each time this function returns to
/// protect against spurious wakeups. /// protect against spurious wakeups.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the mutex being waited on is /// This function will return an error if the mutex being waited on is
/// poisoned when this thread re-acquires the lock. For more information, /// poisoned when this thread re-acquires the lock. For more information,

View file

@ -205,7 +205,7 @@ impl<T: ?Sized> Mutex<T> {
/// held. An RAII guard is returned to allow scoped unlock of the lock. When /// held. An RAII guard is returned to allow scoped unlock of the lock. When
/// the guard goes out of scope, the mutex will be unlocked. /// the guard goes out of scope, the mutex will be unlocked.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error once the mutex is acquired. /// this call will return an error once the mutex is acquired.
@ -223,7 +223,7 @@ impl<T: ?Sized> Mutex<T> {
/// ///
/// This function does not block. /// This function does not block.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return failure if the mutex would otherwise be /// this call will return failure if the mutex would otherwise be
@ -250,7 +250,7 @@ impl<T: ?Sized> Mutex<T> {
/// Consumes this mutex, returning the underlying data. /// Consumes this mutex, returning the underlying data.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error instead. /// this call will return an error instead.
@ -280,7 +280,7 @@ impl<T: ?Sized> Mutex<T> {
/// Since this call borrows the `Mutex` mutably, no actual locking needs to /// Since this call borrows the `Mutex` mutably, no actual locking needs to
/// take place---the mutable borrow statically guarantees no locks exist. /// take place---the mutable borrow statically guarantees no locks exist.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return an error instead. /// this call will return an error instead.

View file

@ -169,7 +169,7 @@ impl<T: ?Sized> RwLock<T> {
/// Returns an RAII guard which will release this thread's shared access /// Returns an RAII guard which will release this thread's shared access
/// once it is dropped. /// once it is dropped.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. /// is poisoned whenever a writer panics while holding an exclusive lock.
@ -192,7 +192,7 @@ impl<T: ?Sized> RwLock<T> {
/// This function does not provide any guarantees with respect to the ordering /// This function does not provide any guarantees with respect to the ordering
/// of whether contentious readers or writers will acquire the lock first. /// of whether contentious readers or writers will acquire the lock first.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. An /// is poisoned whenever a writer panics while holding an exclusive lock. An
@ -217,7 +217,7 @@ impl<T: ?Sized> RwLock<T> {
/// Returns an RAII guard which will drop the write access of this rwlock /// Returns an RAII guard which will drop the write access of this rwlock
/// when dropped. /// when dropped.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. /// is poisoned whenever a writer panics while holding an exclusive lock.
@ -240,7 +240,7 @@ impl<T: ?Sized> RwLock<T> {
/// This function does not provide any guarantees with respect to the ordering /// This function does not provide any guarantees with respect to the ordering
/// of whether contentious readers or writers will acquire the lock first. /// of whether contentious readers or writers will acquire the lock first.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. An /// is poisoned whenever a writer panics while holding an exclusive lock. An
@ -269,7 +269,7 @@ impl<T: ?Sized> RwLock<T> {
/// Consumes this `RwLock`, returning the underlying data. /// Consumes this `RwLock`, returning the underlying data.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. An /// is poisoned whenever a writer panics while holding an exclusive lock. An
@ -301,7 +301,7 @@ impl<T: ?Sized> RwLock<T> {
/// Since this call borrows the `RwLock` mutably, no actual locking needs to /// Since this call borrows the `RwLock` mutably, no actual locking needs to
/// take place---the mutable borrow statically guarantees no locks exist. /// take place---the mutable borrow statically guarantees no locks exist.
/// ///
/// # Failure /// # Errors
/// ///
/// This function will return an error if the RwLock is poisoned. An RwLock /// This function will return an error if the RwLock is poisoned. An RwLock
/// is poisoned whenever a writer panics while holding an exclusive lock. An /// is poisoned whenever a writer panics while holding an exclusive lock. An

View file

@ -78,7 +78,7 @@ impl<T> ReentrantMutex<T> {
/// calling this method already holds the lock, the call shall succeed without /// calling this method already holds the lock, the call shall succeed without
/// blocking. /// blocking.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return failure if the mutex would otherwise be /// this call will return failure if the mutex would otherwise be
@ -95,7 +95,7 @@ impl<T> ReentrantMutex<T> {
/// ///
/// This function does not block. /// This function does not block.
/// ///
/// # Failure /// # Errors
/// ///
/// If another user of this mutex panicked while holding the mutex, then /// If another user of this mutex panicked while holding the mutex, then
/// this call will return failure if the mutex would otherwise be /// this call will return failure if the mutex would otherwise be