about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2019-06-19 15:02:50 +0200
committerGitHub <noreply@github.com>2019-06-19 15:02:50 +0200
commitf25095170251c102c32f6bb0705d1feabbd6fe04 (patch)
tree6e5e36388837a561940e22351416dd0e404d0c3a
parent2eb074dff180743336b022144fae7e88ea849c4b (diff)
downloadrust-f25095170251c102c32f6bb0705d1feabbd6fe04.tar.gz
rust-f25095170251c102c32f6bb0705d1feabbd6fe04.zip
Apply suggestions from code review
Co-Authored-By: Mazdak Farrokhzad <twingoow@gmail.com>
-rw-r--r--src/libcore/pin.rs8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libcore/pin.rs b/src/libcore/pin.rs
index ffea5cbf331..15e28f4f9ae 100644
--- a/src/libcore/pin.rs
+++ b/src/libcore/pin.rs
@@ -182,7 +182,7 @@
 //!     }
 //! }
 //! ```
-//! `inner_drop` has the type that `drop` *should* have, so this makes sure that
+//! The function `inner_drop` has the type that `drop` *should* have, so this makes sure that
 //! you do not accidentally use `self`/`this` in a way that is in conflict with pinning.
 //!
 //! Moreover, if your type is `#[repr(packed)]`, the compiler will automatically
@@ -196,7 +196,7 @@
 //! The usual approach is to write helper methods (so called *projections*)
 //! that turn `Pin<&mut Struct>` into a reference to the field, but what
 //! type should that reference have? Is it `Pin<&mut Field>` or `&mut Field`?
-//! The same question arises with the fields of an enum, and also when considering
+//! The same question arises with the fields of an `enum`, and also when considering
 //! container/wrapper types such as [`Vec<T>`], [`Box<T>`], or [`RefCell<T>`].
 //! (This question applies to both mutable and shared references, we just
 //! use the more common case of mutable references here for illustration.)
@@ -209,7 +209,7 @@
 //! pinning removed as part of the projection. If both are done for the same field,
 //! that will likely be unsound!
 //!
-//! Basically, as the author of a data structure you get to decide for each field whether pinning
+//! As the author of a data structure you get to decide for each field whether pinning
 //! "propagates" to this field or not. Pinning that propagates is also called "structural",
 //! because it follows the structure of the type.
 //! In the following, we describe the considerations that have to be made for either choice.
@@ -235,7 +235,7 @@
 //! ```
 //!
 //! You may also `impl Unpin for Struct` *even if* the type of `field`
-//! is not `Unpin`.  What that type thinks about pinning is just not relevant
+//! is not `Unpin`. What that type thinks about pinning is not relevant
 //! when no `Pin<&mut Field>` is ever created.
 //!
 //! ## Pinning *is* structural for `field`