Skip to content

Improve documentation for std::io::BufWriter - #27155

Merged
bors merged 1 commit into
rust-lang:masterfrom
steveklabnik:doc_std_io_buf_writer
Jul 22, 2015
Merged

Improve documentation for std::io::BufWriter#27155
bors merged 1 commit into
rust-lang:masterfrom
steveklabnik:doc_std_io_buf_writer

Conversation

@steveklabnik

Copy link
Copy Markdown
Contributor

Mostly through adding examples.

r? @alexcrichton

I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.

Comment threadsrc/libstd/io/buffered.rs Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/systemcall/system call/

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

nice catch, thanks

@steveklabnik
steveklabnikforce-pushed the doc_std_io_buf_writer branch from 9b12e54 to 1c380fbCompareJuly 20, 2015 18:35
Comment threadsrc/libstd/io/buffered.rs Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This may want to be a slightly different example, the warning above indicates that this should not be done (bypassing the buffer), so it seems somewhat odd to turn around and call this.

It may be best to either update the comment here just leave it at let reference like the above example.

@steveklabnik
steveklabnikforce-pushed the doc_std_io_buf_writer branch from 1c380fb to eb39df0CompareJuly 21, 2015 17:25
@steveklabnik

Copy link
Copy Markdown
ContributorAuthor

@alexcrichton updated!

@alexcrichton

Copy link
Copy Markdown
Member

@bors: r+ eb39df0

@alexcrichton

Copy link
Copy Markdown
Member

@bors: rollup

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 21, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 21, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 22, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
@steveklabnik
steveklabnikforce-pushed the doc_std_io_buf_writer branch from eb39df0 to e22c6f7CompareJuly 22, 2015 05:21
@steveklabnik

Copy link
Copy Markdown
ContributorAuthor

sigh, it was my fault this time

Mostly through adding examples.
@steveklabnik

Copy link
Copy Markdown
ContributorAuthor

@bors: r=alexcrichton rollup

@bors

bors commented Jul 22, 2015

Copy link
Copy Markdown
Collaborator

📌 Commit e22c6f7 has been approved by alexcrichton

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 22, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 22, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 22, 2015
… r=alexcrichton
Mostly through adding examples.
r? @alexcrichton I'm going to be doing a bunch of these today, but I figured I'd keep it one PR per struct, since the last 'all the things in one PR' ended up taking a week to actually land.
@bors
bors merged commit e22c6f7 into rust-lang:masterJul 22, 2015
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@steveklabnik@alexcrichton@bors@apasel422