Skip to content

Fix minor doc typos. #11934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/libextra/hex.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -60,7 +60,7 @@ pub trait FromHex {
pub enum FromHexError {
/// The input contained a character not part of the hex format
InvalidHexCharacter(char, uint),
/// The input had a invalid length
/// The input had an invalid length
InvalidHexLength,
}

Expand Down
4 changes: 2 additions & 2 deletions src/libextra/num/bigint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1292,7 +1292,7 @@ impl ToStrRadix for BigInt {
}

impl FromStrRadix for BigInt {
/// Creates and initializes an BigInt.
/// Creates and initializes a BigInt.
#[inline]
fn from_str_radix(s: &str, radix: uint) -> Option<BigInt> {
BigInt::parse_bytes(s.as_bytes(), radix)
Expand Down Expand Up @@ -1385,7 +1385,7 @@ impl<R: Rng> RandBigInt for R {
}

impl BigInt {
/// Creates and initializes an BigInt.
/// Creates and initializes a BigInt.
#[inline]
pub fn new(sign: Sign, v: ~[BigDigit]) -> BigInt {
BigInt::from_biguint(sign, BigUint::new(v))
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/kind.rs
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ pub fn check_durable(tcx: ty::ctxt, ty: ty::t, sp: Span) -> bool {
}
}

/// This is rather subtle. When we are casting a value to a instantiated
/// This is rather subtle. When we are casting a value to an instantiated
/// trait like `a as trait<'r>`, regionck already ensures that any references
/// that appear in the type of `a` are bounded by `'r` (ed.: rem
/// FIXME(#5723)). However, it is possible that there are *type parameters*
Expand Down Expand Up @@ -516,7 +516,7 @@ pub fn check_cast_for_escaping_regions(
target_ty: ty::t,
source_span: Span)
{
// Determine what type we are casting to; if it is not an trait, then no
// Determine what type we are casting to; if it is not a trait, then no
// worries.
match ty::get(target_ty).sty {
ty::ty_trait(..) => {}
Expand Down
2 changes: 1 addition & 1 deletion src/librustc/middle/lint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ static lint_table: &'static [(&'static str, LintSpec)] = &[
("unused_must_use",
LintSpec {
lint: UnusedMustUse,
desc: "unused result of an type flagged as #[must_use]",
desc: "unused result of a type flagged as #[must_use]",
default: warn,
}),

Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/trans/_match.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -244,7 +244,7 @@ pub enum VecLenOpt {
vec_len_ge(/* length of prefix */uint)
}

// An option identifying a branch (either a literal, a enum variant or a
// An option identifying a branch (either a literal, an enum variant or a
// range)
enum Opt {
lit(Lit),
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/ty.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -2580,7 +2580,7 @@ pub fn type_is_sized(cx: ctxt, ty: ty::t) -> bool {
}
}

// Whether a type is enum like, that is a enum type with only nullary
// Whether a type is enum like, that is an enum type with only nullary
// constructors
pub fn type_is_c_like_enum(cx: ctxt, ty: t) -> bool {
match get(ty).sty {
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/typeck/astconv.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -294,7 +294,7 @@ pub fn ast_ty_to_ty<AC:AstConv, RS:RegionScope>(
}

// Handle @, ~, and & being able to mean strs and vecs.
// If a_seq_ty is a str or a vec, make it an str/vec.
// If a_seq_ty is a str or a vec, make it a str/vec.
// Also handle first-class trait types.
fn mk_pointer<AC:AstConv,
RS:RegionScope>(
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/typeck/check/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -1984,7 +1984,7 @@ pub fn check_expr_with_unifier(fcx: @FnCtxt,
}
}

// could be either a expr_binop or an expr_assign_binop
// could be either an expr_binop or an expr_assign_binop
fn check_binop(fcx: @FnCtxt,
callee_id: ast::NodeId,
expr: &ast::Expr,
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/middle/typeck/collect.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -736,7 +736,7 @@ pub fn instantiate_trait_ref(ccx: &CrateCtxt,
/*!
* Instantiates the path for the given trait reference, assuming that
* it's bound to a valid trait type. Returns the def_id for the defining
* trait. Fails if the type is a type other than an trait type.
* trait. Fails if the type is a type other than a trait type.
*/

// FIXME(#5121) -- distinguish early vs late lifetime params
Expand Down
4 changes: 2 additions & 2 deletions src/librustc/util/sha2.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -476,7 +476,7 @@ pub struct Sha256 {
}

impl Sha256 {
/// Construct an new instance of a SHA-256 digest.
/// Construct a new instance of a SHA-256 digest.
pub fn new() -> Sha256 {
Sha256 {
engine: Engine256::new(&H256)
Expand Down
4 changes: 2 additions & 2 deletions src/librustdoc/html/render.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -101,7 +101,7 @@ pub enum ExternalLocation {
enum Implementor {
/// Paths are displayed specially by omitting the `impl XX for` cruft
PathType(clean::Type),
/// This is the generic representation of an trait implementor, used for
/// This is the generic representation of a trait implementor, used for
/// primitive types and otherwise non-path types.
OtherType(clean::Generics, /* trait */ clean::Type, /* for */ clean::Type),
}
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/any.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -118,7 +118,7 @@ impl<'a> AnyMutRefExt<'a> for &'a mut Any {
}
}

/// Extension methods for a owning `Any` trait object
/// Extension methods for an owning `Any` trait object
pub trait AnyOwnExt {
/// Returns the boxed value if it is of type `T`, or
/// `Err(Self)` if it isn't.
Expand Down
10 changes: 5 additions & 5 deletions src/libstd/ascii.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -27,13 +27,13 @@ use option::{Option, Some, None};
pub struct Ascii { priv chr: u8 }

impl Ascii {
/// Converts a ascii character into a `u8`.
/// Converts an ascii character into a `u8`.
#[inline]
pub fn to_byte(self) -> u8 {
self.chr
}

/// Converts a ascii character into a `char`.
/// Converts an ascii character into a `char`.
#[inline]
pub fn to_char(self) -> char {
self.chr as char
Expand Down Expand Up @@ -314,9 +314,9 @@ impl IterBytes for Ascii {
}
}

/// Trait to convert to a owned byte array by consuming self
/// Trait to convert to an owned byte array by consuming self
pub trait IntoBytes {
/// Converts to a owned byte array by consuming self
/// Converts to an owned byte array by consuming self
fn into_bytes(self) -> ~[u8];
}

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/io/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Some examples of obvious things you might want to do
let lines: ~[~str] = file.lines().collect();
```

* Make an simple HTTP request
* Make a simple HTTP request
FIXME This needs more improvement: TcpStream constructor taking &str,
`write_str` and `write_line` methods.

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/iter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ pub trait Iterator<A> {


/// Creates an iterator that has a `.peek()` method
/// that returns a optional reference to the next element.
/// that returns an optional reference to the next element.
///
/// # Example
///
Expand Down
8 changes: 4 additions & 4 deletions src/libstd/num/f32.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -812,7 +812,7 @@ impl num::ToStrRadix for f32 {
}

/// Convert a string in base 16 to a float.
/// Accepts a optional binary exponent.
/// Accepts an optional binary exponent.
///
/// This function accepts strings such as
///
Expand Down Expand Up @@ -844,7 +844,7 @@ pub fn from_str_hex(num: &str) -> Option<f32> {

impl FromStr for f32 {
/// Convert a string in base 10 to a float.
/// Accepts a optional decimal exponent.
/// Accepts an optional decimal exponent.
///
/// This function accepts strings such as
///
Expand Down Expand Up @@ -876,7 +876,7 @@ impl FromStr for f32 {
}

impl num::FromStrRadix for f32 {
/// Convert a string in an given base to a float.
/// Convert a string in a given base to a float.
///
/// Due to possible conflicts, this function does **not** accept
/// the special values `inf`, `-inf`, `+inf` and `NaN`, **nor**
Expand Down
8 changes: 4 additions & 4 deletions src/libstd/num/f64.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -814,7 +814,7 @@ impl num::ToStrRadix for f64 {
}

/// Convert a string in base 16 to a float.
/// Accepts a optional binary exponent.
/// Accepts an optional binary exponent.
///
/// This function accepts strings such as
///
Expand Down Expand Up @@ -846,7 +846,7 @@ pub fn from_str_hex(num: &str) -> Option<f64> {

impl FromStr for f64 {
/// Convert a string in base 10 to a float.
/// Accepts a optional decimal exponent.
/// Accepts an optional decimal exponent.
///
/// This function accepts strings such as
///
Expand Down Expand Up @@ -878,7 +878,7 @@ impl FromStr for f64 {
}

impl num::FromStrRadix for f64 {
/// Convert a string in an given base to a float.
/// Convert a string in a given base to a float.
///
/// Due to possible conflicts, this function does **not** accept
/// the special values `inf`, `-inf`, `+inf` and `NaN`, **nor**
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/num/strconv.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -517,7 +517,7 @@ static DIGIT_E_RADIX: uint = ('e' as uint) - ('a' as uint) + 11u;
* - `ExpBin`: Accepts numbers with a binary exponent like `42P-8` or
* `FFp128`. The exponent string itself is always base 10.
* Can conflict with `radix`, see Failure.
* - `empty_zero` - Whether to accept a empty `buf` as a 0 or not.
* - `empty_zero` - Whether to accept an empty `buf` as a 0 or not.
* - `ignore_underscores` - Whether all underscores within the string should
* be ignored.
*
Expand Down
2 changes: 1 addition & 1 deletion src/libstd/option.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ impl<T> Option<T> {
// Getting to contained values
/////////////////////////////////////////////////////////////////////////

/// Unwraps a option, yielding the content of a `Some`
/// Unwraps an option, yielding the content of a `Some`
/// Fails if the value is a `None` with a custom failure message provided by `msg`.
#[inline]
pub fn expect<M: Any + Send>(self, msg: M) -> T {
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/result.rs
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ impl<T, E> Result<T, E> {
// Transforming contained values
/////////////////////////////////////////////////////////////////////////

/// Maps an `Result<T, E>` to `Result<U, E>` by applying a function to an
/// Maps a `Result<T, E>` to `Result<U, E>` by applying a function to an
/// contained `Ok` value, leaving an `Err` value untouched.
///
/// This function can be used to compose the results of two functions.
Expand All @@ -120,7 +120,7 @@ impl<T, E> Result<T, E> {
}
}

/// Maps an `Result<T, E>` to `Result<T, F>` by applying a function to an
/// Maps a `Result<T, E>` to `Result<T, F>` by applying a function to an
/// contained `Err` value, leaving an `Ok` value untouched.
///
/// This function can be used to pass through a successful result while handling
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/send_str.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -38,7 +38,7 @@ impl SendStr {
}
}

/// Returns `true` if this `SendStr` wraps an static string
/// Returns `true` if this `SendStr` wraps a static string
#[inline]
pub fn is_static(&self) -> bool {
match *self {
Expand Down
4 changes: 2 additions & 2 deletions src/libstd/str.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -417,7 +417,7 @@ pub struct CharSplitsN<'a, Sep> {
priv invert: bool,
}

/// An iterator over the words of a string, separated by an sequence of whitespace
/// An iterator over the words of a string, separated by a sequence of whitespace
pub type Words<'a> =
Filter<'a, &'a str, CharSplits<'a, extern "Rust" fn(char) -> bool>>;

Expand Down
2 changes: 1 addition & 1 deletion src/libstd/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -803,7 +803,7 @@ pub trait CloneableVector<T> {
/// Copy `self` into a new owned vector
fn to_owned(&self) -> ~[T];

/// Convert `self` into a owned vector, not making a copy if possible.
/// Convert `self` into an owned vector, not making a copy if possible.
fn into_owned(self) -> ~[T];
}

Expand Down
4 changes: 2 additions & 2 deletions src/libsyntax/ast.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -679,7 +679,7 @@ pub enum TokenTree {
//
// As a final, horrifying aside, note that macro-by-example's input is
// also matched by one of these matchers. Holy self-referential! It is matched
// by an MatchSeq, specifically this one:
// by a MatchSeq, specifically this one:
//
// $( $lhs:matchers => $rhs:tt );+
//
Expand Down
Loading