Skip to content

Commit aa5d779

Browse files
committed
auto merge of #11134 : lucab/rust/lucab/libstd-doc, r=cmr
Uniform the short title of modules provided by libstd, in order to make their roles more explicit when glancing at the index.
2 parents afe8f6e + a9a7a42 commit aa5d779

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+50
-42
lines changed

src/libstd/any.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
//! Traits for dynamic typing of any type (through runtime reflection)
12+
//!
1113
//! This module implements the `Any` trait, which enables dynamic typing
1214
//! of any type, through runtime reflection.
1315
//!

src/libstd/ascii.rs

Lines changed: 1 addition & 1 deletion
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 ASCII strings and characters.
11+
//! Operations on ASCII strings and characters
1212
1313
use to_str::{ToStr,IntoStr};
1414
use str;

src/libstd/at_vec.rs

Lines changed: 1 addition & 1 deletion
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-
//! Managed vectors
11+
//! Operations on managed vectors (`@[T]` type)
1212
1313
use clone::Clone;
1414
use container::Container;

src/libstd/bool.rs

Lines changed: 1 addition & 1 deletion
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-
//! The `bool` module contains useful code to help work with boolean values.
11+
//! Operations on boolean values (`bool` type)
1212
//!
1313
//! A quick summary:
1414
//!

src/libstd/char.rs

Lines changed: 1 addition & 1 deletion
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 manipulating the char type
11+
//! Unicode characters manipulation (`char` type)
1212
1313
use cast::transmute;
1414
use option::{None, Option, Some};

src/libstd/clone.rs

Lines changed: 1 addition & 1 deletion
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-
/*! The Clone trait for types that cannot be "implicitly copied"
11+
/*! The `Clone` trait for types that cannot be 'implicitly copied'
1212
1313
In Rust, some simple types are "implicitly copyable" and when you
1414
assign them or pass them as arguments, the receiver will get a copy,

src/libstd/comm/mod.rs

Lines changed: 1 addition & 1 deletion
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-
//! Rust Communication Primitives
11+
//! Communication primitives for concurrent tasks (`Chan` and `Port` types)
1212
//!
1313
//! Rust makes it very difficult to share data among tasks to prevent race
1414
//! conditions and to improve parallelism, but there is often a need for

src/libstd/container.rs

Lines changed: 1 addition & 1 deletion
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-
//! Container traits
11+
//! Traits for generic containers (including `Map` and `Set`)
1212
1313
use option::Option;
1414

src/libstd/default.rs

Lines changed: 1 addition & 1 deletion
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-
//! The Default trait
11+
//! The `Default` trait for types which may have meaningful default values
1212
1313
/// A trait that types which have a useful default value should implement.
1414
pub trait Default {

src/libstd/either.rs

Lines changed: 1 addition & 1 deletion
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-
//! A type that represents one of two alternatives
11+
//! Representing values with two possibilities (`Either` type)
1212
1313
#[allow(missing_doc)];
1414

0 commit comments

Comments
 (0)