Skip to content

std: small doc fixes for BufReader and BufWriter #26784

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 8, 2015
Merged

std: small doc fixes for BufReader and BufWriter #26784

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions src/libstd/io/buffered.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ use io::{self, DEFAULT_BUF_SIZE, Error, ErrorKind, SeekFrom};
use ptr;
use iter;

/// Wraps a `Read` and buffers input from it
/// Wraps a `Read` and buffers input from it.
Copy link
Member

Choose a reason for hiding this comment

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

Convention is to use full sentences, actually, so I'd prefer to leave this (and others)

///
/// It can be excessively inefficient to work directly with a `Read` instance.
/// For example, every call to `read` on `TcpStream` results in a system call.
Expand Down Expand Up @@ -54,13 +54,13 @@ pub struct BufReader<R> {
}

impl<R: Read> BufReader<R> {
/// Creates a new `BufReader` with a default buffer capacity
/// Creates a new `BufReader` with a default buffer capacity.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn new(inner: R) -> BufReader<R> {
BufReader::with_capacity(DEFAULT_BUF_SIZE, inner)
}

/// Creates a new `BufReader` with the specified buffer capacity
/// Creates a new `BufReader` with the specified buffer capacity.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn with_capacity(cap: usize, inner: R) -> BufReader<R> {
let mut buf = Vec::with_capacity(cap);
Expand Down Expand Up @@ -183,7 +183,7 @@ impl<R: Seek> Seek for BufReader<R> {
}
}

/// Wraps a Writer and buffers output to it
/// Wraps a Writer and buffers output to it.
///
/// It can be excessively inefficient to work directly with a `Write`. For
/// example, every call to `write` on `TcpStream` results in a system call. A
Expand All @@ -205,13 +205,13 @@ pub struct BufWriter<W: Write> {
pub struct IntoInnerError<W>(W, Error);

impl<W: Write> BufWriter<W> {
/// Creates a new `BufWriter` with a default buffer capacity
/// Creates a new `BufWriter` with a default buffer capacity.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn new(inner: W) -> BufWriter<W> {
BufWriter::with_capacity(DEFAULT_BUF_SIZE, inner)
}

/// Creates a new `BufWriter` with the specified buffer capacity
/// Creates a new `BufWriter` with the specified buffer capacity.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn with_capacity(cap: usize, inner: W) -> BufWriter<W> {
BufWriter {
Expand Down Expand Up @@ -253,11 +253,11 @@ impl<W: Write> BufWriter<W> {
#[stable(feature = "rust1", since = "1.0.0")]
pub fn get_ref(&self) -> &W { self.inner.as_ref().unwrap() }

/// Gets a mutable reference to the underlying write.
/// Gets a mutable reference to the underlying writer.
///
/// # Warning
///
/// It is inadvisable to directly read from the underlying writer.
/// It is inadvisable to directly write to the underlying writer.
#[stable(feature = "rust1", since = "1.0.0")]
pub fn get_mut(&mut self) -> &mut W { self.inner.as_mut().unwrap() }

Expand Down