Skip to content

Commit

Permalink
std: uniform modules titles for doc
Browse files Browse the repository at this point in the history
This commit uniforms the short title of modules provided by libstd,
in order to make their roles more explicit when glancing at the index.

Signed-off-by: Luca Bruno <lucab@debian.org>
  • Loading branch information
lucab committed Dec 27, 2013
1 parent 00d87e0 commit a9a7a42
Show file tree
Hide file tree
Showing 44 changed files with 50 additions and 42 deletions.
2 changes: 2 additions & 0 deletions src/libstd/any.rs
Expand Up @@ -8,6 +8,8 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Traits for dynamic typing of any type (through runtime reflection)
//!
//! This module implements the `Any` trait, which enables dynamic typing
//! of any type, through runtime reflection.
//!
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/ascii.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Operations on ASCII strings and characters.
//! Operations on ASCII strings and characters

use to_str::{ToStr,IntoStr};
use str;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/at_vec.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Managed vectors
//! Operations on managed vectors (`@[T]` type)

use clone::Clone;
use container::Container;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/bool.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! The `bool` module contains useful code to help work with boolean values.
//! Operations on boolean values (`bool` type)
//!
//! A quick summary:
//!
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/char.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Utilities for manipulating the char type
//! Unicode characters manipulation (`char` type)

use cast::transmute;
use option::{None, Option, Some};
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/clone.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

/*! The Clone trait for types that cannot be "implicitly copied"
/*! The `Clone` trait for types that cannot be 'implicitly copied'
In Rust, some simple types are "implicitly copyable" and when you
assign them or pass them as arguments, the receiver will get a copy,
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/comm/mod.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Rust Communication Primitives
//! Communication primitives for concurrent tasks (`Chan` and `Port` types)
//!
//! Rust makes it very difficult to share data among tasks to prevent race
//! conditions and to improve parallelism, but there is often a need for
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/container.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Container traits
//! Traits for generic containers (including `Map` and `Set`)

use option::Option;

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/default.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! The Default trait
//! The `Default` trait for types which may have meaningful default values

/// A trait that types which have a useful default value should implement.
pub trait Default {
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/either.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! A type that represents one of two alternatives
//! Representing values with two possibilities (`Either` type)

#[allow(missing_doc)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/fmt/mod.rs
Expand Up @@ -10,7 +10,7 @@

/*!
The Formatting Module
Utilities for formatting and printing strings
This module contains the runtime support for the `format!` syntax extension.
This macro is implemented in the compiler to emit calls to this module in order
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/from_str.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! The trait for types that can be created from strings
//! The `FromStr` trait for types that can be created from strings

use option::Option;

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/hashmap.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! An unordered map and set type implemented as hash tables
//! Unordered containers, implemented as hash-tables (`HashSet` and `HashMap` types)
//!
//! The tables use a keyed hash with new random keys generated for each container, so the ordering
//! of a set of keys in a hash table is randomized.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/kinds.rs
Expand Up @@ -9,7 +9,7 @@
// except according to those terms.

/*!
The kind traits
Primitive traits representing basic 'kinds' of types
Rust types can be classified in various useful ways according to
intrinsic properties of the type. These classifications, often called
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/logging.rs
Expand Up @@ -10,7 +10,7 @@

/*!
Logging
Utilities for program-wide and customizable logging
This module is used by the compiler when emitting output for the logging family
of macros. The methods of this module shouldn't necessarily be used directly,
Expand Down
2 changes: 2 additions & 0 deletions src/libstd/num/cmath.rs
Expand Up @@ -12,6 +12,8 @@
#[allow(non_uppercase_statics)];
#[allow(dead_code)];

//! Bindings for the C math library (for basic mathematic functions)

// function names are almost identical to C's libmath, a few have been
// renamed, grep for "rename:"

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/f32.rs
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 `f32`
//! Operations and constants for 32-bits floats (`f32` type)
#[allow(missing_doc)];

use prelude::*;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/f64.rs
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 `f64`
//! Operations and constants for 64-bits floats (`f64` type)

#[allow(missing_doc)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i16.rs
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 `i16`
//! Operations and constants for signed 16-bits integers (`i16` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i32.rs
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 `i32`
//! Operations and constants for signed 32-bits integers (`i32` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i64.rs
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 `i64`
//! Operations and constants for signed 64-bits integers (`i64` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/i8.rs
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 `i8`
//! Operations and constants for signed 8-bits integers (`i8` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/int.rs
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 `int`
//! Operations and constants for architecture-sized signed integers (`int` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/mod.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Numeric traits and functions for generic mathematics.
//! Numeric traits and functions for generic mathematics
//!
//! These are implemented for the primitive numeric types in `std::{u8, u16,
//! u32, u64, uint, i8, i16, i32, i64, int, f32, f64, float}`.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u16.rs
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 `u16`
//! Operations and constants for unsigned 16-bits integers (`u16` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u32.rs
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 `u32`
//! Operations and constants for unsigned 32-bits integers (`u32` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u64.rs
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 `u64`
//! Operations and constants for unsigned 64-bits integer (`u64` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/u8.rs
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 `u8`
//! Operations and constants for unsigned 8-bits integers (`u8` type)

#[allow(non_uppercase_statics)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/num/uint.rs
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 `uint`
//! Operations and constants for architecture-sized unsigned integers (`uint` type)

#[allow(non_uppercase_statics)];

Expand Down
6 changes: 4 additions & 2 deletions src/libstd/ops.rs
Expand Up @@ -13,8 +13,10 @@

/*!
*
* Traits for the built-in operators. Implementing these traits allows you to get
* an effect similar to overloading operators.
* Traits representing built-in operators, useful for overloading
*
* Implementing these traits allows you to get an effect similar to
* overloading operators.
*
* The values for the right hand side of an operator are automatically
* borrowed, so `a + b` is sugar for `a.add(&b)`.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/option.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Operations on the ubiquitous `Option` type.
//! Optionally nullable values (`Option` type)
//!
//! Type `Option` represents an optional value.
//!
Expand Down
2 changes: 2 additions & 0 deletions src/libstd/prelude.rs
Expand Up @@ -10,6 +10,8 @@

/*!
The standard module imported by default into all Rust modules
Many programming languages have a 'prelude': a particular subset of the
libraries that come with the language. Every program imports the prelude by
default.
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rand/mod.rs
Expand Up @@ -9,7 +9,7 @@
// except according to those terms.

/*!
Random number generation.
Utilities for random number generation
The key functions are `random()` and `Rng::gen()`. These are polymorphic
and so can be used to generate any type that implements `Rand`. Type inference
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rc.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

/*! Task-local reference counted boxes
/*! Task-local reference-counted boxes (`Rc` type)
The `Rc` type provides shared ownership of an immutable value. Destruction is deterministic, and
will occur as soon as the last owner is gone. It is marked as non-sendable because it avoids the
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/result.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! A type representing either success or failure
//! Signaling success or failure states (`Result` type)

use clone::Clone;
use cmp::Eq;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/rt/mod.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

/*! The Rust Runtime, including the task scheduler and I/O
/*! Runtime services, including the task scheduler and I/O dispatcher
The `rt` module provides the private runtime infrastructure necessary
to support core language features like the exchange and local heap,
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/run.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Process spawning.
//! Utilities for spawning and managing processes

#[allow(missing_doc)];

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/send_str.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! `SendStr` definition and trait implementations
//! The `SendStr` trait for optionally static strings

use clone::{Clone, DeepClone};
use cmp::{Eq, TotalEq, Ord, TotalOrd, Equiv};
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/str.rs
Expand Up @@ -10,7 +10,7 @@

/*!
String manipulation
Unicode string manipulation (`str` type)
# Basic Usage
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/task.rs
Expand Up @@ -9,7 +9,7 @@
// except according to those terms.

/*!
* Task management.
* Utilities for managing and scheduling tasks
*
* An executing Rust program consists of a tree of tasks, each with their own
* stack, and sole ownership of their allocated heap data. Tasks communicate
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/to_bytes.rs
Expand Up @@ -10,7 +10,7 @@

/*!
The `ToBytes` and `IterBytes` traits
The `ToBytes` and `IterBytes` traits for converting to raw bytes
*/

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/trie.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! An ordered map and set for integer keys implemented as a radix trie
//! Ordered containers with integer keys, implemented as radix tries (`TrieSet` and `TrieMap` types)

use prelude::*;
use uint;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/util.rs
Expand Up @@ -8,7 +8,7 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Miscellaneous helpers for common patterns.
//! Miscellaneous helpers for common patterns

use cast;
use ptr;
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/vec.rs
Expand Up @@ -10,7 +10,7 @@

/*!
Vector manipulation
Utilities for vector manipulation
The `vec` module contains useful code to help work with vector values.
Vectors are Rust's list type. Vectors contain zero or more values of
Expand Down

5 comments on commit a9a7a42

@bors
Copy link
Contributor

@bors bors commented on a9a7a42 Dec 29, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

saw approval from cmr
at lucab@a9a7a42

@bors
Copy link
Contributor

@bors bors commented on a9a7a42 Dec 29, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merging lucab/rust/lucab/libstd-doc = a9a7a42 into auto

@bors
Copy link
Contributor

@bors bors commented on a9a7a42 Dec 29, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lucab/rust/lucab/libstd-doc = a9a7a42 merged ok, testing candidate = aa5d779

@bors
Copy link
Contributor

@bors bors commented on a9a7a42 Dec 29, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bors
Copy link
Contributor

@bors bors commented on a9a7a42 Dec 29, 2013

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast-forwarding master to auto = aa5d779

Please sign in to comment.