Skip to content

Commit

Permalink
doc: Clean up primitive short descriptions
Browse files Browse the repository at this point in the history
This makes the primitive descriptions on the front page read properly
as descriptions of types and not of the associated modules.
  • Loading branch information
brson committed Jul 20, 2015
1 parent 47265bb commit 44dd247
Show file tree
Hide file tree
Showing 19 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion src/libcollections/slice.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/libcollections/str.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/libcore/ptr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/libcore/tuple.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/librustc_unicode/char.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/array.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/f32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/f64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i16.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i8.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/isize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u16.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u32.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u64.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u8.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/usize.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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")]
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/tuple.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 44dd247

Please sign in to comment.