about summary refs log tree commit diff
path: root/library
diff options
context:
space:
mode:
authorRuan Comelli <ruancomelli@gmail.com>2025-04-13 16:11:55 -0300
committerRuan Comelli <ruancomelli@gmail.com>2025-04-13 16:11:55 -0300
commit6f23f167af57af26543fa93f87a12f637e66c5e8 (patch)
tree2ab06f753dca9189a2c5c7c334a6e989715b6f14 /library
parent14662fabeb69fe5ab6c6e68051bf9f80d4aaaa35 (diff)
downloadrust-6f23f167af57af26543fa93f87a12f637e66c5e8.tar.gz
rust-6f23f167af57af26543fa93f87a12f637e66c5e8.zip
docs(library/core/src/pin): rewrite for clarity
Diffstat (limited to 'library')
-rw-r--r--library/core/src/pin.rs10
1 files changed, 5 insertions, 5 deletions
diff --git a/library/core/src/pin.rs b/library/core/src/pin.rs
index 504801f3e4e..9ee5369139f 100644
--- a/library/core/src/pin.rs
+++ b/library/core/src/pin.rs
@@ -12,11 +12,11 @@
 //! "pinned," in that it has been permanently (until the end of its lifespan) attached to its
 //! location in memory, as though pinned to a pinboard. Pinning a value is an incredibly useful
 //! building block for [`unsafe`] code to be able to reason about whether a raw pointer to the
-//! pinned value is still valid. [As we'll see later][drop-guarantee], this is necessary from the
-//! time the value is first pinned until the end of its lifespan. This concept of "pinning" is
-//! necessary to implement safe interfaces on top of things like self-referential types and
-//! intrusive data structures which cannot currently be modeled in fully safe Rust using only
-//! borrow-checked [references][reference].
+//! pinned value is still valid. [As we'll see later][drop-guarantee], once a value is pinned,
+//! it is necessarily valid at its memory location until the end of its lifespan. This concept
+//! of "pinning" is necessary to implement safe interfaces on top of things like self-referential
+//! types and intrusive data structures which cannot currently be modeled in fully safe Rust using
+//! only borrow-checked [references][reference].
 //!
 //! "Pinning" allows us to put a *value* which exists at some location in memory into a state where
 //! safe code cannot *move* that value to a different location in memory or otherwise invalidate it