Skip to content

Commit c3fd65b

Browse files
committed
link Unpin to pin module documentation
1 parent bfed149 commit c3fd65b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/libcore/marker.rs

+2
Original file line numberDiff line numberDiff line change
@@ -611,6 +611,7 @@ unsafe impl<'a, T: ?Sized> Freeze for &'a mut T {}
611611
/// Instead it can be used to prevent moves through the type system,
612612
/// by controlling the behavior of special pointer types like [`PinMut`],
613613
/// which "pin" the type in place by not allowing it to be moved out of them.
614+
/// See the [`pin module`] documentation for more information on pinning.
614615
///
615616
/// Implementing this trait lifts the restrictions of pinning off a type,
616617
/// which then allows it to move out with functions such as [`replace`].
@@ -632,6 +633,7 @@ unsafe impl<'a, T: ?Sized> Freeze for &'a mut T {}
632633
///
633634
/// [`replace`]: ../../core/mem/fn.replace.html
634635
/// [`PinMut`]: ../pin/struct.PinMut.html
636+
/// [`pin module`]: ../../alloc/pin/index.html
635637
#[unstable(feature = "pin", issue = "49150")]
636638
pub auto trait Unpin {}
637639

0 commit comments

Comments
 (0)