about summary refs log tree commit diff
path: root/src/libstd/primitive_docs.rs
diff options
context:
space:
mode:
authorHavvy <ryan.havvy@gmail.com>2017-09-16 20:40:05 -0700
committerHavvy <ryan.havvy@gmail.com>2017-09-20 21:11:03 -0700
commit548686ff12322f948652ee6523074b2ce6d2bb06 (patch)
tree3cb0d0bf3a9a0ea669af284c9cbfe21765fdaf7a /src/libstd/primitive_docs.rs
parentb492405b1fcfb8243481582182a0232fb5177021 (diff)
downloadrust-548686ff12322f948652ee6523074b2ce6d2bb06.tar.gz
rust-548686ff12322f948652ee6523074b2ce6d2bb06.zip
Document stable size_of primitives and pointer size guarantees
Diffstat (limited to 'src/libstd/primitive_docs.rs')
-rw-r--r--src/libstd/primitive_docs.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/libstd/primitive_docs.rs b/src/libstd/primitive_docs.rs
index 76ef36cc9a7..1edb35d8fe7 100644
--- a/src/libstd/primitive_docs.rs
+++ b/src/libstd/primitive_docs.rs
@@ -710,6 +710,10 @@ mod prim_u128 { }
 //
 /// The pointer-sized signed integer type.
 ///
+/// The size of this primitive is how many bytes it takes to reference any
+/// location in memory. For example, on a 32 bit target, this is 4 bytes
+/// and on a 64 bit target, this is 8 bytes.
+///
 /// *[See also the `std::isize` module](isize/index.html).*
 ///
 /// However, please note that examples are shared between primitive integer
@@ -722,6 +726,10 @@ mod prim_isize { }
 //
 /// The pointer-sized unsigned integer type.
 ///
+/// The size of this primitive is how many bytes it takes to reference any
+/// location in memory. For example, on a 32 bit target, this is 4 bytes
+/// and on a 64 bit target, this is 8 bytes.
+///
 /// *[See also the `std::usize` module](usize/index.html).*
 ///
 /// However, please note that examples are shared between primitive integer