about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2019-02-19 20:54:31 +0100
committerRalf Jung <post@ralfj.de>2019-02-19 20:54:31 +0100
commitc774bc650a6b19e6ca6b970dda294ba8937a6548 (patch)
treedb99d5722fe424a43c8ef142610a6b71d0fffd76
parent30403802068b920eb3b3f6ffbc1e89068de43292 (diff)
downloadrust-c774bc650a6b19e6ca6b970dda294ba8937a6548.tar.gz
rust-c774bc650a6b19e6ca6b970dda294ba8937a6548.zip
examples
-rw-r--r--src/libcore/pin.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/libcore/pin.rs b/src/libcore/pin.rs
index 2d674fe4f79..a142fd811ad 100644
--- a/src/libcore/pin.rs
+++ b/src/libcore/pin.rs
@@ -36,7 +36,9 @@
 //!
 //! However, these restrictions are usually not necessary. Many types are always freely
 //! movable, even when pinned, because they do not rely on having a stable address.
-//! These types implement the [`Unpin`] auto-trait, which
+//! This includes all the basic types (`bool`, `i32` and friends, references)
+//! as well as types consisting solely of these types.
+//! Types that do not care about pinning implement the [`Unpin`] auto-trait, which
 //! nullifies the effect of [`Pin`]. For `T: Unpin`, `Pin<Box<T>>` and `Box<T>` function
 //! identically, as do `Pin<&mut T>` and `&mut T`.
 //!