about summary refs log tree commit diff
path: root/src/libstd/primitive_docs.rs
diff options
context:
space:
mode:
authorNathaniel Ringo <remexre@gmail.com>2017-08-22 11:56:38 -0500
committerNathaniel Ringo <remexre@gmail.com>2017-08-22 12:00:05 -0500
commitc987f30049c954be378f847c8bef730fdb95cab8 (patch)
treef21c63bc9535ccd5d3209a80dfb381bd3725b39d /src/libstd/primitive_docs.rs
parenta24e0f25d7a0ac793b37eb4db353d5f9f2befc97 (diff)
downloadrust-c987f30049c954be378f847c8bef730fdb95cab8.tar.gz
rust-c987f30049c954be378f847c8bef730fdb95cab8.zip
Mention null_mut on the pointer primitive docs.
Also adds a few mentions that both `*const` and `*mut` support
functions, when only `*const` was mentioned before.
Diffstat (limited to 'src/libstd/primitive_docs.rs')
-rw-r--r--src/libstd/primitive_docs.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs
index 6746754ebc3..76ef36cc9a7 100644
--- a/src/libstd/primitive_docs.rs
+++ b/src/libstd/primitive_docs.rs
@@ -188,9 +188,10 @@ mod prim_unit { }
 /// Working with raw pointers in Rust is uncommon,
 /// typically limited to a few patterns.
 ///
-/// Use the [`null`] function to create null pointers, and the [`is_null`] method
-/// of the `*const T` type  to check for null. The `*const T` type also defines
-/// the [`offset`] method, for pointer math.
+/// Use the [`null`] and [`null_mut`] functions to create null pointers, and the
+/// [`is_null`] method of the `*const T` and `*mut T` types to check for null.
+/// The `*const T` and `*mut T` types also define the [`offset`] method, for
+/// pointer math.
 ///
 /// # Common ways to create raw pointers
 ///
@@ -261,6 +262,7 @@ mod prim_unit { }
 /// *[See also the `std::ptr` module](ptr/index.html).*
 ///
 /// [`null`]: ../std/ptr/fn.null.html
+/// [`null_mut`]: ../std/ptr/fn.null_mut.html
 /// [`is_null`]: ../std/primitive.pointer.html#method.is_null
 /// [`offset`]: ../std/primitive.pointer.html#method.offset
 /// [`into_raw`]: ../std/boxed/struct.Box.html#method.into_raw