提交 49ee9f3f 编写于 作者: L lukaramu

Fix inconsistent doc headings

This fixes headings reading "Unsafety" and "Example", they should be
"Safety" and "Examples" according to RFC 1574.
上级 af6298d5
...@@ -110,7 +110,7 @@ pub fn from_size_align(size: usize, align: usize) -> Option<Layout> { ...@@ -110,7 +110,7 @@ pub fn from_size_align(size: usize, align: usize) -> Option<Layout> {
/// Creates a layout, bypassing all checks. /// Creates a layout, bypassing all checks.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe as it does not verify that `align` is /// This function is unsafe as it does not verify that `align` is
/// a power-of-two that is also less than or equal to 2^31, nor /// a power-of-two that is also less than or equal to 2^31, nor
...@@ -485,7 +485,7 @@ pub unsafe trait Alloc { ...@@ -485,7 +485,7 @@ pub unsafe trait Alloc {
/// behavior, e.g. to ensure initialization to particular sets of /// behavior, e.g. to ensure initialization to particular sets of
/// bit patterns.) /// bit patterns.)
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure that `layout` has non-zero size. /// if the caller does not ensure that `layout` has non-zero size.
...@@ -513,7 +513,7 @@ pub unsafe trait Alloc { ...@@ -513,7 +513,7 @@ pub unsafe trait Alloc {
/// Deallocate the memory referenced by `ptr`. /// Deallocate the memory referenced by `ptr`.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure all of the following: /// if the caller does not ensure all of the following:
...@@ -617,7 +617,7 @@ fn usable_size(&self, layout: &Layout) -> (usize, usize) { ...@@ -617,7 +617,7 @@ fn usable_size(&self, layout: &Layout) -> (usize, usize) {
/// behavior is well-defined (though underspecified) when this /// behavior is well-defined (though underspecified) when this
/// constraint is violated; further discussion below. /// constraint is violated; further discussion below.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure all of the following: /// if the caller does not ensure all of the following:
...@@ -688,7 +688,7 @@ unsafe fn realloc(&mut self, ...@@ -688,7 +688,7 @@ unsafe fn realloc(&mut self,
/// Behaves like `alloc`, but also ensures that the contents /// Behaves like `alloc`, but also ensures that the contents
/// are set to zero before being returned. /// are set to zero before being returned.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe for the same reasons that `alloc` is. /// This function is unsafe for the same reasons that `alloc` is.
/// ///
...@@ -714,7 +714,7 @@ unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> { ...@@ -714,7 +714,7 @@ unsafe fn alloc_zeroed(&mut self, layout: Layout) -> Result<*mut u8, AllocErr> {
/// the returned block. For some `layout` inputs, like arrays, this /// the returned block. For some `layout` inputs, like arrays, this
/// may include extra storage usable for additional data. /// may include extra storage usable for additional data.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe for the same reasons that `alloc` is. /// This function is unsafe for the same reasons that `alloc` is.
/// ///
...@@ -736,7 +736,7 @@ unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr> { ...@@ -736,7 +736,7 @@ unsafe fn alloc_excess(&mut self, layout: Layout) -> Result<Excess, AllocErr> {
/// the returned block. For some `layout` inputs, like arrays, this /// the returned block. For some `layout` inputs, like arrays, this
/// may include extra storage usable for additional data. /// may include extra storage usable for additional data.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe for the same reasons that `realloc` is. /// This function is unsafe for the same reasons that `realloc` is.
/// ///
...@@ -770,7 +770,7 @@ unsafe fn realloc_excess(&mut self, ...@@ -770,7 +770,7 @@ unsafe fn realloc_excess(&mut self,
/// memory block referenced by `ptr` has not been transferred, and /// memory block referenced by `ptr` has not been transferred, and
/// the contents of the memory block are unaltered. /// the contents of the memory block are unaltered.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure all of the following: /// if the caller does not ensure all of the following:
...@@ -827,7 +827,7 @@ unsafe fn grow_in_place(&mut self, ...@@ -827,7 +827,7 @@ unsafe fn grow_in_place(&mut self,
/// the memory block has not been transferred, and the contents of /// the memory block has not been transferred, and the contents of
/// the memory block are unaltered. /// the memory block are unaltered.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure all of the following: /// if the caller does not ensure all of the following:
...@@ -920,7 +920,7 @@ fn alloc_one<T>(&mut self) -> Result<Unique<T>, AllocErr> ...@@ -920,7 +920,7 @@ fn alloc_one<T>(&mut self) -> Result<Unique<T>, AllocErr>
/// ///
/// Captures a common usage pattern for allocators. /// Captures a common usage pattern for allocators.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure both: /// if the caller does not ensure both:
...@@ -993,7 +993,7 @@ fn alloc_array<T>(&mut self, n: usize) -> Result<Unique<T>, AllocErr> ...@@ -993,7 +993,7 @@ fn alloc_array<T>(&mut self, n: usize) -> Result<Unique<T>, AllocErr>
/// The returned block is suitable for passing to the /// The returned block is suitable for passing to the
/// `alloc`/`realloc` methods of this allocator. /// `alloc`/`realloc` methods of this allocator.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure all of the following: /// if the caller does not ensure all of the following:
...@@ -1037,7 +1037,7 @@ unsafe fn realloc_array<T>(&mut self, ...@@ -1037,7 +1037,7 @@ unsafe fn realloc_array<T>(&mut self,
/// ///
/// Captures a common usage pattern for allocators. /// Captures a common usage pattern for allocators.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function is unsafe because undefined behavior can result /// This function is unsafe because undefined behavior can result
/// if the caller does not ensure both: /// if the caller does not ensure both:
......
...@@ -633,7 +633,7 @@ impl<I: FusedIterator + ?Sized> FusedIterator for Box<I> {} ...@@ -633,7 +633,7 @@ impl<I: FusedIterator + ?Sized> FusedIterator for Box<I> {}
/// that `FnBox` may be deprecated in the future if `Box<FnOnce()>` /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
/// closures become directly usable.) /// closures become directly usable.)
/// ///
/// ### Example /// # Examples
/// ///
/// Here is a snippet of code which creates a hashmap full of boxed /// Here is a snippet of code which creates a hashmap full of boxed
/// once closures and then removes them one by one, calling each /// once closures and then removes them one by one, calling each
......
...@@ -171,7 +171,7 @@ pub fn to_vec<T>(s: &[T]) -> Vec<T> ...@@ -171,7 +171,7 @@ pub fn to_vec<T>(s: &[T]) -> Vec<T>
impl<T> [T] { impl<T> [T] {
/// Returns the number of elements in the slice. /// Returns the number of elements in the slice.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let a = [1, 2, 3]; /// let a = [1, 2, 3];
...@@ -185,7 +185,7 @@ pub fn len(&self) -> usize { ...@@ -185,7 +185,7 @@ pub fn len(&self) -> usize {
/// Returns `true` if the slice has a length of 0. /// Returns `true` if the slice has a length of 0.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let a = [1, 2, 3]; /// let a = [1, 2, 3];
...@@ -523,7 +523,7 @@ pub fn swap(&mut self, a: usize, b: usize) { ...@@ -523,7 +523,7 @@ pub fn swap(&mut self, a: usize, b: usize) {
/// Reverses the order of elements in the slice, in place. /// Reverses the order of elements in the slice, in place.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let mut v = [1, 2, 3]; /// let mut v = [1, 2, 3];
...@@ -580,7 +580,7 @@ pub fn iter_mut(&mut self) -> IterMut<T> { ...@@ -580,7 +580,7 @@ pub fn iter_mut(&mut self) -> IterMut<T> {
/// ///
/// Panics if `size` is 0. /// Panics if `size` is 0.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let slice = ['r', 'u', 's', 't']; /// let slice = ['r', 'u', 's', 't'];
...@@ -613,7 +613,7 @@ pub fn windows(&self, size: usize) -> Windows<T> { ...@@ -613,7 +613,7 @@ pub fn windows(&self, size: usize) -> Windows<T> {
/// ///
/// Panics if `size` is 0. /// Panics if `size` is 0.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let slice = ['l', 'o', 'r', 'e', 'm']; /// let slice = ['l', 'o', 'r', 'e', 'm'];
...@@ -1040,7 +1040,7 @@ pub fn ends_with(&self, needle: &[T]) -> bool ...@@ -1040,7 +1040,7 @@ pub fn ends_with(&self, needle: &[T]) -> bool
/// `Err` is returned, containing the index where a matching /// `Err` is returned, containing the index where a matching
/// element could be inserted while maintaining sorted order. /// element could be inserted while maintaining sorted order.
/// ///
/// # Example /// # Examples
/// ///
/// Looks up a series of four elements. The first is found, with a /// Looks up a series of four elements. The first is found, with a
/// uniquely determined position; the second and third are not /// uniquely determined position; the second and third are not
...@@ -1074,7 +1074,7 @@ pub fn binary_search(&self, x: &T) -> Result<usize, usize> ...@@ -1074,7 +1074,7 @@ pub fn binary_search(&self, x: &T) -> Result<usize, usize>
/// `Err` is returned, containing the index where a matching /// `Err` is returned, containing the index where a matching
/// element could be inserted while maintaining sorted order. /// element could be inserted while maintaining sorted order.
/// ///
/// # Example /// # Examples
/// ///
/// Looks up a series of four elements. The first is found, with a /// Looks up a series of four elements. The first is found, with a
/// uniquely determined position; the second and third are not /// uniquely determined position; the second and third are not
...@@ -1419,7 +1419,7 @@ pub fn rotate(&mut self, mid: usize) { ...@@ -1419,7 +1419,7 @@ pub fn rotate(&mut self, mid: usize) {
/// ///
/// This function will panic if the two slices have different lengths. /// This function will panic if the two slices have different lengths.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let mut dst = [0, 0, 0]; /// let mut dst = [0, 0, 0];
...@@ -1445,7 +1445,7 @@ pub fn clone_from_slice(&mut self, src: &[T]) where T: Clone { ...@@ -1445,7 +1445,7 @@ pub fn clone_from_slice(&mut self, src: &[T]) where T: Clone {
/// ///
/// This function will panic if the two slices have different lengths. /// This function will panic if the two slices have different lengths.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// let mut dst = [0, 0, 0]; /// let mut dst = [0, 0, 0];
......
...@@ -1714,7 +1714,7 @@ pub fn trim_right_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str ...@@ -1714,7 +1714,7 @@ pub fn trim_right_matches<'a, P: Pattern<'a>>(&'a self, pat: P) -> &'a str
/// ///
/// [`Err`]: str/trait.FromStr.html#associatedtype.Err /// [`Err`]: str/trait.FromStr.html#associatedtype.Err
/// ///
/// # Example /// # Examples
/// ///
/// Basic usage /// Basic usage
/// ///
......
...@@ -998,7 +998,7 @@ pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> { ...@@ -998,7 +998,7 @@ pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> {
/// A method would interfere with methods of the same name on the contents /// A method would interfere with methods of the same name on the contents
/// of a `RefCell` used through `Deref`. /// of a `RefCell` used through `Deref`.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::cell::{RefCell, Ref}; /// use std::cell::{RefCell, Ref};
...@@ -1040,7 +1040,7 @@ impl<'b, T: ?Sized> RefMut<'b, T> { ...@@ -1040,7 +1040,7 @@ impl<'b, T: ?Sized> RefMut<'b, T> {
/// `RefMut::map(...)`. A method would interfere with methods of the same /// `RefMut::map(...)`. A method would interfere with methods of the same
/// name on the contents of a `RefCell` used through `Deref`. /// name on the contents of a `RefCell` used through `Deref`.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::cell::{RefCell, RefMut}; /// use std::cell::{RefCell, RefMut};
......
...@@ -58,7 +58,7 @@ fn write_str(&mut self, mut s: &str) -> fmt::Result { ...@@ -58,7 +58,7 @@ fn write_str(&mut self, mut s: &str) -> fmt::Result {
/// [`Formatter::debug_struct`](struct.Formatter.html#method.debug_struct) /// [`Formatter::debug_struct`](struct.Formatter.html#method.debug_struct)
/// method. /// method.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::fmt; /// use std::fmt;
...@@ -153,7 +153,7 @@ fn is_pretty(&self) -> bool { ...@@ -153,7 +153,7 @@ fn is_pretty(&self) -> bool {
/// [`Formatter::debug_tuple`](struct.Formatter.html#method.debug_tuple) /// [`Formatter::debug_tuple`](struct.Formatter.html#method.debug_tuple)
/// method. /// method.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::fmt; /// use std::fmt;
...@@ -290,7 +290,7 @@ fn is_pretty(&self) -> bool { ...@@ -290,7 +290,7 @@ fn is_pretty(&self) -> bool {
/// [`Formatter::debug_set`](struct.Formatter.html#method.debug_set) /// [`Formatter::debug_set`](struct.Formatter.html#method.debug_set)
/// method. /// method.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::fmt; /// use std::fmt;
...@@ -361,7 +361,7 @@ pub fn finish(&mut self) -> fmt::Result { ...@@ -361,7 +361,7 @@ pub fn finish(&mut self) -> fmt::Result {
/// [`Formatter::debug_list`](struct.Formatter.html#method.debug_list) /// [`Formatter::debug_list`](struct.Formatter.html#method.debug_list)
/// method. /// method.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::fmt; /// use std::fmt;
...@@ -432,7 +432,7 @@ pub fn finish(&mut self) -> fmt::Result { ...@@ -432,7 +432,7 @@ pub fn finish(&mut self) -> fmt::Result {
/// [`Formatter::debug_map`](struct.Formatter.html#method.debug_map) /// [`Formatter::debug_map`](struct.Formatter.html#method.debug_map)
/// method. /// method.
/// ///
/// # Example /// # Examples
/// ///
/// ``` /// ```
/// use std::fmt; /// use std::fmt;
......
...@@ -901,7 +901,7 @@ pub fn into_inner(slot: ManuallyDrop<T>) -> T { ...@@ -901,7 +901,7 @@ pub fn into_inner(slot: ManuallyDrop<T>) -> T {
/// Manually drops the contained value. /// Manually drops the contained value.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This function runs the destructor of the contained value and thus the wrapped value /// This function runs the destructor of the contained value and thus the wrapped value
/// now represents uninitialized data. It is up to the user of this method to ensure the /// now represents uninitialized data. It is up to the user of this method to ensure the
......
...@@ -522,7 +522,7 @@ pub trait Read { ...@@ -522,7 +522,7 @@ pub trait Read {
/// `Read`er - the method only takes `&self` so that it can be used through /// `Read`er - the method only takes `&self` so that it can be used through
/// trait objects. /// trait objects.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This method is unsafe because a `Read`er could otherwise return a /// This method is unsafe because a `Read`er could otherwise return a
/// non-zeroing `Initializer` from another `Read` type without an `unsafe` /// non-zeroing `Initializer` from another `Read` type without an `unsafe`
...@@ -903,7 +903,7 @@ pub fn zeroing() -> Initializer { ...@@ -903,7 +903,7 @@ pub fn zeroing() -> Initializer {
/// Returns a new `Initializer` which will not zero out buffers. /// Returns a new `Initializer` which will not zero out buffers.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This may only be called by `Read`ers which guarantee that they will not /// This may only be called by `Read`ers which guarantee that they will not
/// read from buffers passed to `Read` methods, and that the return value of /// read from buffers passed to `Read` methods, and that the return value of
......
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
/// magnitude faster than `haystack.iter().position(|&b| b == needle)`. /// magnitude faster than `haystack.iter().position(|&b| b == needle)`.
/// (See benchmarks.) /// (See benchmarks.)
/// ///
/// # Example /// # Examples
/// ///
/// This shows how to find the first position of a byte in a byte string. /// This shows how to find the first position of a byte in a byte string.
/// ///
...@@ -40,7 +40,7 @@ pub fn memchr(needle: u8, haystack: &[u8]) -> Option<usize> { ...@@ -40,7 +40,7 @@ pub fn memchr(needle: u8, haystack: &[u8]) -> Option<usize> {
/// Returns the index corresponding to the last occurrence of `needle` in /// Returns the index corresponding to the last occurrence of `needle` in
/// `haystack`, or `None` if one is not found. /// `haystack`, or `None` if one is not found.
/// ///
/// # Example /// # Examples
/// ///
/// This shows how to find the last position of a byte in a byte string. /// This shows how to find the last position of a byte in a byte string.
/// ///
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
//! For now, this module is limited to extracting file descriptors, //! For now, this module is limited to extracting file descriptors,
//! but its functionality will grow over time. //! but its functionality will grow over time.
//! //!
//! # Example //! # Examples
//! //!
//! ```no_run //! ```no_run
//! use std::fs::File; //! use std::fs::File;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
//! For now, this module is limited to extracting file descriptors, //! For now, this module is limited to extracting file descriptors,
//! but its functionality will grow over time. //! but its functionality will grow over time.
//! //!
//! # Example //! # Examples
//! //!
//! ```no_run //! ```no_run
//! use std::fs::File; //! use std::fs::File;
......
...@@ -807,7 +807,7 @@ pub fn park_timeout_ms(ms: u32) { ...@@ -807,7 +807,7 @@ pub fn park_timeout_ms(ms: u32) {
/// Platforms which do not support nanosecond precision for sleeping will have /// Platforms which do not support nanosecond precision for sleeping will have
/// `dur` rounded up to the nearest granularity of time they can sleep for. /// `dur` rounded up to the nearest granularity of time they can sleep for.
/// ///
/// # Example /// # Examples
/// ///
/// Waiting for the complete expiration of the timeout: /// Waiting for the complete expiration of the timeout:
/// ///
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册