Fix BufRead::read_until documentation. #36851
Merged
Conversation
This file contains hidden or 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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
bluss
suggested changes
Sep 30, 2016
| @@ -1270,10 +1270,6 @@ pub trait BufRead: Read { | |||
| /// delimiter or EOF is found. Once found, all bytes up to, and including, | |||
| /// the delimiter (if found) will be appended to `buf`. | |||
| /// | |||
| /// If this reader is currently at EOF then this function will not modify | |||
| /// `buf` and will return `Ok(n)` where `n` is the number of bytes which | |||
| /// were read. | |||
There was a problem hiding this comment.
Yes this is confusingly written, but it's the only place where the Ok return is mentioned, can we thus keep some kind of explanation of what the return value Ok(n) means for this method?
There was a problem hiding this comment.
Added some actual description of successful return value, and done similar
change to read_line.
bluss
approved these changes
Sep 30, 2016
|
@bors r+ rollup Thanks |
|
📌 Commit 1e8f692 has been approved by |
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this pull request
Sep 30, 2016
Fix BufRead::read_until documentation. Second paragraph already fully explains what happens when EOF is encountered. The third paragraph (removed one) is spurious and misleading.
bors
added a commit
that referenced
this pull request
Sep 30, 2016
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.
Second paragraph already fully explains what happens when EOF is
encountered. The third paragraph (removed one) is spurious and
misleading.