mirror of
https://github.com/rust-lang/rust.git
synced 2025-04-28 11:07:42 +00:00
Rollup merge of #55839 - dralley:docstring-spelling, r=TimNN
Fix docstring spelling mistakes
This commit is contained in:
commit
417b10a0e3
@ -350,9 +350,8 @@ macro_rules! try {
|
||||
/// assert_eq!(v, b"s = \"abc 123\"");
|
||||
/// ```
|
||||
///
|
||||
/// Note: This macro can be used in `no_std` setups as well
|
||||
/// In a `no_std` setup you are responsible for the
|
||||
/// implementation details of the components.
|
||||
/// Note: This macro can be used in `no_std` setups as well.
|
||||
/// In a `no_std` setup you are responsible for the implementation details of the components.
|
||||
///
|
||||
/// ```no_run
|
||||
/// # extern crate core;
|
||||
@ -440,7 +439,7 @@ macro_rules! writeln {
|
||||
///
|
||||
/// If the determination that the code is unreachable proves incorrect, the
|
||||
/// program immediately terminates with a [`panic!`]. The function [`unreachable_unchecked`],
|
||||
/// which belongs to the [`std::hint`] module, informs the compilier to
|
||||
/// which belongs to the [`std::hint`] module, informs the compiler to
|
||||
/// optimize the code out of the release version entirely.
|
||||
///
|
||||
/// [`panic!`]: ../std/macro.panic.html
|
||||
|
@ -3,7 +3,7 @@
|
||||
//! It is sometimes useful to have objects that are guaranteed to not move,
|
||||
//! in the sense that their placement in memory does not change, and can thus be relied upon.
|
||||
//!
|
||||
//! A prime example of such a scenario would be building self-referencial structs,
|
||||
//! A prime example of such a scenario would be building self-referential structs,
|
||||
//! since moving an object with pointers to itself will invalidate them,
|
||||
//! which could cause undefined behavior.
|
||||
//!
|
||||
@ -39,7 +39,7 @@
|
||||
//! use std::marker::Pinned;
|
||||
//! use std::ptr::NonNull;
|
||||
//!
|
||||
//! // This is a self referencial struct since the slice field points to the data field.
|
||||
//! // This is a self-referential struct since the slice field points to the data field.
|
||||
//! // We cannot inform the compiler about that with a normal reference,
|
||||
//! // since this pattern cannot be described with the usual borrowing rules.
|
||||
//! // Instead we use a raw pointer, though one which is known to not be null,
|
||||
|
Loading…
Reference in New Issue
Block a user