Improve documentation for std::io::LineWriter #27166
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
steveklabnik
force-pushed
the
doc_std_io_linewriter
branch
from
e114990 to
5e9129a
Compare
| /// (`0x0a`, `'\n'`) is detected. | ||
| /// | ||
| /// The buffer will be written out when the writer is dropped. | ||
| /// The [`BufWriter`][bufwriter] struct wraps a writer and buffers its output. | ||
| /// But it only does this batched write when it goes out of scope. Sometimes, |
There was a problem hiding this comment.
This clause isn't quite true as it will write the internal buffer whenever it goes out of scope or it fills up the internal buffer (e.g. it's not infinitely buffered)
steveklabnik
force-pushed
the
doc_std_io_linewriter
branch
from
5e9129a to
94b8f28
Compare
|
updated! |
|
@bors: rollup |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 21, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 21, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 22, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 22, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
steveklabnik
force-pushed
the
doc_std_io_linewriter
branch
from
94b8f28 to
e31ad95
Compare
Beef up the struct docs, add examples for the methods.
|
@bors: r=alexcrichton rollup |
|
📌 Commit e31ad95 has been approved by |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 22, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Jul 22, 2015
… r=alexcrichton Beef up the struct docs, add examples for the methods. r? @alexcrichton
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.
Beef up the struct docs, add examples for the methods.
r? @alexcrichton