OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rollup merge of #58718 - Centril:doc-convention-safety, r=RalfJung

Browse Source 
Apply docs convention: Replace # Unsafety with # Safety in docs

As used in RFC 1574: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#using-markdown

"Safety" is used many times more than "Unsafety" is within existing docs.

@bors rollup

r? @RalfJung
This commit is contained in:
Mazdak Farrokhzad 2019-02-25 11:42:23 +01:00 committed by GitHub
commit 2019d965c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/libcore/alloc.rs
View File

@ -420,7 +420,7 @@ impl fmt::Display for CannotReallocInPlace {
/// } /// }
/// ``` /// ```
/// ///
/// # Unsafety /// # Safety
/// ///
/// The `GlobalAlloc` trait is an `unsafe` trait for a number of reasons, and /// The `GlobalAlloc` trait is an `unsafe` trait for a number of reasons, and
/// implementors must ensure that they adhere to these contracts: /// implementors must ensure that they adhere to these contracts:
@ -643,7 +643,7 @@ pub unsafe trait GlobalAlloc {
/// currently allocated via an allocator `a`, then it is legal to /// currently allocated via an allocator `a`, then it is legal to
/// use that layout to deallocate it, i.e., `a.dealloc(ptr, k);`. /// use that layout to deallocate it, i.e., `a.dealloc(ptr, k);`.
/// ///
/// # Unsafety /// # Safety
/// ///
/// The `Alloc` trait is an `unsafe` trait for a number of reasons, and /// The `Alloc` trait is an `unsafe` trait for a number of reasons, and
/// implementors must ensure that they adhere to these contracts: /// implementors must ensure that they adhere to these contracts:

6
src/libcore/mem.rs
View File

@ -1173,7 +1173,7 @@ impl<T> MaybeUninit<T> {
/// to ensure that the data will get dropped, because the resulting `T` is /// to ensure that the data will get dropped, because the resulting `T` is
/// subject to the usual drop handling. /// subject to the usual drop handling.
/// ///
/// # Unsafety /// # Safety
/// ///
/// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized /// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized
/// state. Calling this when the content is not yet fully initialized causes undefined /// state. Calling this when the content is not yet fully initialized causes undefined
@ -1187,7 +1187,7 @@ impl<T> MaybeUninit<T> {
/// Gets a reference to the contained value. /// Gets a reference to the contained value.
/// ///
/// # Unsafety /// # Safety
/// ///
/// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized /// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized
/// state. Calling this when the content is not yet fully initialized causes undefined /// state. Calling this when the content is not yet fully initialized causes undefined
@ -1200,7 +1200,7 @@ impl<T> MaybeUninit<T> {
/// Gets a mutable reference to the contained value. /// Gets a mutable reference to the contained value.
/// ///
/// # Unsafety /// # Safety
/// ///
/// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized /// It is up to the caller to guarantee that the `MaybeUninit` really is in an initialized
/// state. Calling this when the content is not yet fully initialized causes undefined /// state. Calling this when the content is not yet fully initialized causes undefined

4
src/libcore/slice/mod.rs
View File

@ -2158,7 +2158,7 @@ impl<T> [T] {
/// This method has no purpose when either input element `T` or output element `U` are /// This method has no purpose when either input element `T` or output element `U` are
/// zero-sized and will return the original slice without splitting anything. /// zero-sized and will return the original slice without splitting anything.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This method is essentially a `transmute` with respect to the elements in the returned /// This method is essentially a `transmute` with respect to the elements in the returned
/// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here. /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.
@ -2211,7 +2211,7 @@ impl<T> [T] {
/// This method has no purpose when either input element `T` or output element `U` are /// This method has no purpose when either input element `T` or output element `U` are
/// zero-sized and will return the original slice without splitting anything. /// zero-sized and will return the original slice without splitting anything.
/// ///
/// # Unsafety /// # Safety
/// ///
/// This method is essentially a `transmute` with respect to the elements in the returned /// This method is essentially a `transmute` with respect to the elements in the returned
/// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here. /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.