about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBrian Anderson <banderson@mozilla.com>2015-07-17 16:28:04 -0700
committerBrian Anderson <banderson@mozilla.com>2015-07-20 13:17:41 -0700
commit44dd247cd5ced8ae8a8c6f1d04463abce21c8e9e (patch)
tree107138e203675db258f5bcf581cf3b68ecce942f
parent47265bbf37385a087235a8c5eddea5944ae6465e (diff)
downloadrust-44dd247cd5ced8ae8a8c6f1d04463abce21c8e9e.tar.gz
rust-44dd247cd5ced8ae8a8c6f1d04463abce21c8e9e.zip
doc: Clean up primitive short descriptions
This makes the primitive descriptions on the front page read properly
as descriptions of types and not of the associated modules.
-rw-r--r--src/libcollections/slice.rs2
-rw-r--r--src/libcollections/str.rs2
-rw-r--r--src/libcore/ptr.rs2
-rw-r--r--src/libcore/tuple.rs2
-rw-r--r--src/librustc_unicode/char.rs2
-rw-r--r--src/libstd/array.rs4
-rw-r--r--src/libstd/num/f32.rs2
-rw-r--r--src/libstd/num/f64.rs2
-rw-r--r--src/libstd/num/i16.rs2
-rw-r--r--src/libstd/num/i32.rs2
-rw-r--r--src/libstd/num/i64.rs2
-rw-r--r--src/libstd/num/i8.rs2
-rw-r--r--src/libstd/num/isize.rs2
-rw-r--r--src/libstd/num/u16.rs2
-rw-r--r--src/libstd/num/u32.rs2
-rw-r--r--src/libstd/num/u64.rs2
-rw-r--r--src/libstd/num/u8.rs2
-rw-r--r--src/libstd/num/usize.rs2
-rw-r--r--src/libstd/tuple.rs2
19 files changed, 20 insertions, 20 deletions
diff --git a/src/libcollections/slice.rs b/src/libcollections/slice.rs
index f5a27565ef7..ae6cda793d0 100644
--- a/src/libcollections/slice.rs
+++ b/src/libcollections/slice.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Utilities for slice manipulation
+//! A dynamically-sized view into a contiguous sequence, `[T]`.
 //!
 //! The `slice` module contains useful code to help work with slice values.
 //! Slices are a view into a block of memory represented as a pointer and a
diff --git a/src/libcollections/str.rs b/src/libcollections/str.rs
index cb6613998b4..8ab1464379f 100644
--- a/src/libcollections/str.rs
+++ b/src/libcollections/str.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Unicode string manipulation (the `str` type).
+//! Unicode string slices
 //!
 //! Rust's `str` type is one of the core primitive types of the language. `&str`
 //! is the borrowed string type. This type of string can only be created from
diff --git a/src/libcore/ptr.rs b/src/libcore/ptr.rs
index 7b33a41f955..b47ced03fba 100644
--- a/src/libcore/ptr.rs
+++ b/src/libcore/ptr.rs
@@ -10,7 +10,7 @@
 
 // FIXME: talk about offset, copy_memory, copy_nonoverlapping_memory
 
-//! Operations on raw pointers, `*const T`, and `*mut T`.
+//! Raw, unsafe pointers, `*const T`, and `*mut T`
 //!
 //! Working with raw pointers in Rust is uncommon,
 //! typically limited to a few patterns.
diff --git a/src/libcore/tuple.rs b/src/libcore/tuple.rs
index ba6a7c4a5fe..9e97078c529 100644
--- a/src/libcore/tuple.rs
+++ b/src/libcore/tuple.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations on tuples
+//! A finite heterogeneous sequence, `(T, U, ..)`
 //!
 //! To access a single element of a tuple one can use the `.0`
 //! field access syntax.
diff --git a/src/librustc_unicode/char.rs b/src/librustc_unicode/char.rs
index 2596620d39d..fb9ff267762 100644
--- a/src/librustc_unicode/char.rs
+++ b/src/librustc_unicode/char.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Character manipulation (`char` type, Unicode Scalar Value)
+//! A Unicode scalar value
 //!
 //! This module provides the `CharExt` trait, as well as its
 //! implementation for the primitive `char` type, in order to allow
diff --git a/src/libstd/array.rs b/src/libstd/array.rs
index 0dfcc72e379..f6d133319c8 100644
--- a/src/libstd/array.rs
+++ b/src/libstd/array.rs
@@ -8,8 +8,8 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! A fixed-size array is denoted `[T; N]` for the element type `T` and
-//! the compile time constant size `N`. The size must be zero or positive.
+//! A fixed-size array, denoted `[T; N]`, for the element type, `T`, and
+//! the non-negative compile time constant size, `N`.
 //!
 //! Arrays values are created either with an explicit expression that lists
 //! each element: `[x, y, z]` or a repeat expression: `[x; N]`. The repeat
diff --git a/src/libstd/num/f32.rs b/src/libstd/num/f32.rs
index 10cdc0c5833..561b84ca21a 100644
--- a/src/libstd/num/f32.rs
+++ b/src/libstd/num/f32.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for 32-bits floats (`f32` type)
+//! The 32-bit floating point type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![allow(missing_docs)]
diff --git a/src/libstd/num/f64.rs b/src/libstd/num/f64.rs
index 41c0fcb9797..8a77566faeb 100644
--- a/src/libstd/num/f64.rs
+++ b/src/libstd/num/f64.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for 64-bits floats (`f64` type)
+//! The 32-bit floating point type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![allow(missing_docs)]
diff --git a/src/libstd/num/i16.rs b/src/libstd/num/i16.rs
index 498f19b9b83..04a45072d1a 100644
--- a/src/libstd/num/i16.rs
+++ b/src/libstd/num/i16.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for signed 16-bits integers (`i16` type)
+//! The 16-bit signed integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "i16")]
diff --git a/src/libstd/num/i32.rs b/src/libstd/num/i32.rs
index aea1e92117b..09177c188de 100644
--- a/src/libstd/num/i32.rs
+++ b/src/libstd/num/i32.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for signed 32-bits integers (`i32` type)
+//! The 32-bit signed integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "i32")]
diff --git a/src/libstd/num/i64.rs b/src/libstd/num/i64.rs
index 43794345fe7..84fccc9d25f 100644
--- a/src/libstd/num/i64.rs
+++ b/src/libstd/num/i64.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for signed 64-bits integers (`i64` type)
+//! The 64-bit signed integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "i64")]
diff --git a/src/libstd/num/i8.rs b/src/libstd/num/i8.rs
index 1b03bf6f4f0..f0e84883847 100644
--- a/src/libstd/num/i8.rs
+++ b/src/libstd/num/i8.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for signed 8-bits integers (`i8` type)
+//! The 8-bit signed integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "i8")]
diff --git a/src/libstd/num/isize.rs b/src/libstd/num/isize.rs
index aa89f858f6f..b602c7c704a 100644
--- a/src/libstd/num/isize.rs
+++ b/src/libstd/num/isize.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for pointer-sized signed integers (`isize` type)
+//! The pointer-sized signed integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "isize")]
diff --git a/src/libstd/num/u16.rs b/src/libstd/num/u16.rs
index 3fda77fb69c..17f25402200 100644
--- a/src/libstd/num/u16.rs
+++ b/src/libstd/num/u16.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for unsigned 16-bits integers (`u16` type)
+//! The 16-bit unsigned integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "u16")]
diff --git a/src/libstd/num/u32.rs b/src/libstd/num/u32.rs
index 8610f0c0147..13be3677dac 100644
--- a/src/libstd/num/u32.rs
+++ b/src/libstd/num/u32.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for unsigned 32-bits integers (`u32` type)
+//! The 32-bit unsigned integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "u32")]
diff --git a/src/libstd/num/u64.rs b/src/libstd/num/u64.rs
index 3587b069656..40b6e138307 100644
--- a/src/libstd/num/u64.rs
+++ b/src/libstd/num/u64.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for unsigned 64-bits integer (`u64` type)
+//! The 64-bit unsigned integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "u64")]
diff --git a/src/libstd/num/u8.rs b/src/libstd/num/u8.rs
index 6a285e8299c..02fc807e1f2 100644
--- a/src/libstd/num/u8.rs
+++ b/src/libstd/num/u8.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for unsigned 8-bits integers (`u8` type)
+//! The 8-bit unsigned integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "u8")]
diff --git a/src/libstd/num/usize.rs b/src/libstd/num/usize.rs
index b54d8ae96c5..548c0dbb8dc 100644
--- a/src/libstd/num/usize.rs
+++ b/src/libstd/num/usize.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations and constants for pointer-sized unsigned integers (`usize` type)
+//! The pointer-sized unsigned integer type
 
 #![stable(feature = "rust1", since = "1.0.0")]
 #![doc(primitive = "usize")]
diff --git a/src/libstd/tuple.rs b/src/libstd/tuple.rs
index 08aa979cf63..1e4de19c874 100644
--- a/src/libstd/tuple.rs
+++ b/src/libstd/tuple.rs
@@ -8,7 +8,7 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-//! Operations on tuples
+//! A finite heterogeneous sequence, `(T, U, ..)`
 //!
 //! To access the _N_-th element of a tuple one can use `N` itself
 //! as a field of the tuple.