bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

pluralize doc comment verbs and add missing periods

Browse source
This commit is contained in:
Andrew Paseltiner 2015-04-13 10:21:32 -04:00
parent 588d37c653
commit 6fa16d6a47
66 changed files with 380 additions and 380 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/libstd/io/mod.rs
View file

@ -220,14 +220,14 @@ pub trait Read {
append_to_string(buf, |b| read_to_end(self, b))
}
/// Create a "by reference" adaptor for this instance of `Read`.
/// Creates a "by reference" adaptor for this instance of `Read`.
///
/// The returned adaptor also implements `Read` and will simply borrow this
/// current reader.
#[stable(feature = "rust1", since = "1.0.0")]
fn by_ref(&mut self) -> &mut Self where Self: Sized { self }
/// Transform this `Read` instance to an `Iterator` over its bytes.
/// Transforms this `Read` instance to an `Iterator` over its bytes.
///
/// The returned type implements `Iterator` where the `Item` is `Result<u8,
/// R::Err>`. The yielded item is `Ok` if a byte was successfully read and
@ -238,7 +238,7 @@ pub trait Read {
Bytes { inner: self }
}
/// Transform this `Read` instance to an `Iterator` over `char`s.
/// Transforms this `Read` instance to an `Iterator` over `char`s.
///
/// This adaptor will attempt to interpret this reader as an UTF-8 encoded
/// sequence of characters. The returned iterator will return `None` once
@ -255,7 +255,7 @@ pub trait Read {
Chars { inner: self }
}
/// Create an adaptor which will chain this stream with another.
/// Creates an adaptor which will chain this stream with another.
///
/// The returned `Read` instance will first read all bytes from this object
/// until EOF is encountered. Afterwards the output is equivalent to the
@ -265,7 +265,7 @@ pub trait Read {
Chain { first: self, second: next, done_first: false }
}
/// Create an adaptor which will read at most `limit` bytes from it.
/// Creates an adaptor which will read at most `limit` bytes from it.
///
/// This function returns a new instance of `Read` which will read at most
/// `limit` bytes, after which it will always return EOF (`Ok(0)`). Any
@ -406,7 +406,7 @@ pub trait Write {
}
}
/// Create a "by reference" adaptor for this instance of `Write`.
/// Creates a "by reference" adaptor for this instance of `Write`.
///
/// The returned adaptor also implements `Write` and will simply borrow this
/// current writer.