about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2024-01-07 00:27:01 +0000
committerManish Goregaokar <manishsmail@gmail.com>2024-01-07 08:56:24 -0800
commit68bdeddb5cc6ec3ee787a94d7373928048e5b81b (patch)
tree4efc50791f6c9f30c863b801db26d163e12ad8aa
parent4c25246f3e94002795e7652feac6ef6fa0415de2 (diff)
downloadrust-68bdeddb5cc6ec3ee787a94d7373928048e5b81b.tar.gz
rust-68bdeddb5cc6ec3ee787a94d7373928048e5b81b.zip
Apply suggestions from code review
Co-authored-by: Ralf Jung <post@ralfj.de>
Co-authored-by: Daniel Henry-Mantilla <daniel.henry.mantilla@gmail.com>
-rw-r--r--library/core/src/pin.rs8
1 files changed, 4 insertions, 4 deletions
diff --git a/library/core/src/pin.rs b/library/core/src/pin.rs
index 3926a661dce..a8ef5949e7a 100644
--- a/library/core/src/pin.rs
+++ b/library/core/src/pin.rs
@@ -146,10 +146,10 @@
 //! There are two possible ways to ensure the invariants required for 2. and 3. above (which
 //! apply to any address-sensitive type, not just self-referrential types) do not get broken.
 //!
-//! 1. Have the value detect when it is moved and update all the pointers that point to itself
+//! 1. Have the value detect when it is moved and update all the pointers that point to itself.
 //! 2. Guarantee that the address of the value does not change (and that memory is not re-used
 //! for anything else) during the time that the pointers to it are expected to be valid to
-//! dereference
+//! dereference.
 //!
 //! Since, as we discussed, Rust can move values without notifying them that they have moved, the
 //! first option is ruled out.
@@ -203,7 +203,7 @@
 //! will not be *moved* or [otherwise invalidated][subtle-details].
 //!
 //! We call such a [`Pin`]-wrapped pointer a **pinning pointer,** (or pinning reference, or pinning
-//! `Box`, etc.) because its existince is the thing that is *symbolically* pinning the underlying
+//! `Box`, etc.) because its existence is the thing that is conceptually pinning the underlying
 //! pointee in place: it is the metaphorical "pin" securing the data in place on the pinboard
 //! (in memory).
 //!
@@ -332,7 +332,7 @@
 //!
 //! ## [`Unpin`]
 //!
-//! The vast majority of Rust types have no address-sensitive states; these types
+//! The vast majority of Rust types have no address-sensitive states. These types
 //! implement the [`Unpin`] auto-trait, which cancels the restrictive effects of
 //! [`Pin`] when the *pointee* type `T` is [`Unpin`]. When [`T: Unpin`][Unpin],
 //! <code>[Pin]<[Box]\<T>></code> functions identically to a non-pinning [`Box<T>`]; similarly,