Skip to content

Commit 44dd247

Browse files
committed
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.
1 parent 47265bb commit 44dd247

File tree

19 files changed

+20
-20
lines changed

19 files changed

+20
-20
lines changed

src/libcollections/slice.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Utilities for slice manipulation
11+
//! A dynamically-sized view into a contiguous sequence, `[T]`.
1212
//!
1313
//! The `slice` module contains useful code to help work with slice values.
1414
//! Slices are a view into a block of memory represented as a pointer and a

src/libcollections/str.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Unicode string manipulation (the `str` type).
11+
//! Unicode string slices
1212
//!
1313
//! Rust's `str` type is one of the core primitive types of the language. `&str`
1414
//! is the borrowed string type. This type of string can only be created from

src/libcore/ptr.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
// FIXME: talk about offset, copy_memory, copy_nonoverlapping_memory
1212

13-
//! Operations on raw pointers, `*const T`, and `*mut T`.
13+
//! Raw, unsafe pointers, `*const T`, and `*mut T`
1414
//!
1515
//! Working with raw pointers in Rust is uncommon,
1616
//! typically limited to a few patterns.

src/libcore/tuple.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations on tuples
11+
//! A finite heterogeneous sequence, `(T, U, ..)`
1212
//!
1313
//! To access a single element of a tuple one can use the `.0`
1414
//! field access syntax.

src/librustc_unicode/char.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Character manipulation (`char` type, Unicode Scalar Value)
11+
//! A Unicode scalar value
1212
//!
1313
//! This module provides the `CharExt` trait, as well as its
1414
//! implementation for the primitive `char` type, in order to allow

src/libstd/array.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! A fixed-size array is denoted `[T; N]` for the element type `T` and
12-
//! the compile time constant size `N`. The size must be zero or positive.
11+
//! A fixed-size array, denoted `[T; N]`, for the element type, `T`, and
12+
//! the non-negative compile time constant size, `N`.
1313
//!
1414
//! Arrays values are created either with an explicit expression that lists
1515
//! each element: `[x, y, z]` or a repeat expression: `[x; N]`. The repeat

src/libstd/num/f32.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for 32-bits floats (`f32` type)
11+
//! The 32-bit floating point type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![allow(missing_docs)]

src/libstd/num/f64.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for 64-bits floats (`f64` type)
11+
//! The 32-bit floating point type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![allow(missing_docs)]

src/libstd/num/i16.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for signed 16-bits integers (`i16` type)
11+
//! The 16-bit signed integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "i16")]

src/libstd/num/i32.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for signed 32-bits integers (`i32` type)
11+
//! The 32-bit signed integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "i32")]

src/libstd/num/i64.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for signed 64-bits integers (`i64` type)
11+
//! The 64-bit signed integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "i64")]

src/libstd/num/i8.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for signed 8-bits integers (`i8` type)
11+
//! The 8-bit signed integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "i8")]

src/libstd/num/isize.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for pointer-sized signed integers (`isize` type)
11+
//! The pointer-sized signed integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "isize")]

src/libstd/num/u16.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for unsigned 16-bits integers (`u16` type)
11+
//! The 16-bit unsigned integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "u16")]

src/libstd/num/u32.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for unsigned 32-bits integers (`u32` type)
11+
//! The 32-bit unsigned integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "u32")]

src/libstd/num/u64.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for unsigned 64-bits integer (`u64` type)
11+
//! The 64-bit unsigned integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "u64")]

src/libstd/num/u8.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for unsigned 8-bits integers (`u8` type)
11+
//! The 8-bit unsigned integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "u8")]

src/libstd/num/usize.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations and constants for pointer-sized unsigned integers (`usize` type)
11+
//! The pointer-sized unsigned integer type
1212
1313
#![stable(feature = "rust1", since = "1.0.0")]
1414
#![doc(primitive = "usize")]

src/libstd/tuple.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
//! Operations on tuples
11+
//! A finite heterogeneous sequence, `(T, U, ..)`
1212
//!
1313
//! To access the _N_-th element of a tuple one can use `N` itself
1414
//! as a field of the tuple.

0 commit comments

Comments
 (0)