Improve documentation for std::io::BufWriter #27155
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// ``` | ||
| /// | ||
| /// Because we're not buffering, we write each one in turn, incurring the | ||
| /// overhead of a systemcall per byte written. We can fix this with a |
There was a problem hiding this comment.
s/systemcall/system call/
steveklabnik
force-pushed
the
doc_std_io_buf_writer
branch
from
9b12e54 to
1c380fb
Compare
| /// let reference = buffer.get_mut(); | ||
| /// | ||
| /// // we can use reference just like buffer | ||
| /// reference.write(&[42]).unwrap(); |
There was a problem hiding this comment.
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
force-pushed
the
doc_std_io_buf_writer
branch
from
1c380fb to
eb39df0
Compare
|
@alexcrichton updated! |
|
@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
force-pushed
the
doc_std_io_buf_writer
branch
from
eb39df0 to
e22c6f7
Compare
|
sigh, it was my fault this time |
Mostly through adding examples.
|
@bors: r=alexcrichton rollup |
|
📌 Commit e22c6f7 has been approved by |
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
added a commit
that referenced
this pull request
Jul 22, 2015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.