Add documentation for Read, Write impls for slices and Vec #37343
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
|
r? @brson (rust_highfive has picked a reviewer for you, use r? to override) |
bluss
force-pushed
the
write-doc
branch
2 times, most recently
from
f0414a9 to
6c67764
Compare
GuillaumeGomez
requested changes
Oct 27, 2016
| @@ -147,6 +147,11 @@ impl<B: BufRead + ?Sized> BufRead for Box<B> { | |||
| // ============================================================================= | |||
| // In-memory buffer implementations | |||
|
|
|||
| /// Read is implemented for `&[u8]` by copying from the slice. | |||
| /// | |||
| /// Note that each read from the slice updates the slice itself so that after | |||
There was a problem hiding this comment.
This sentence is too long and it makes it difficult to read.
| /// | ||
| /// Note that each read from the slice updates the slice itself so that after | ||
| /// each read, the slice points only to the yet unread part. The slice will be | ||
| /// empty when end of file is reached. |
There was a problem hiding this comment.
"when the end of the input"?
There was a problem hiding this comment.
The Read trait calls this situation "end of file" (with quotes) and/or EOF. So I want to keep that terminology. Using either EOF or "end of file" should be good?
| /// Write is implemented for `&mut [u8]` by copying into the slice, overwriting | ||
| /// its data. | ||
| /// | ||
| /// Note that each write to the slice updates the slice itself so that after |
There was a problem hiding this comment.
Same, the sentence is too long.
|
Updated |
| /// Note that each read from the slice updates the slice itself so that after | ||
| /// each read, the slice points only to the yet unread part. The slice will be | ||
| /// empty when end of file is reached. | ||
| /// Note that reading updates the slice to point to just the yet unread part. |
There was a problem hiding this comment.
"Note that reading updates the slice to point to the yet unread part."? (I removed "just")
| /// Note that each write to the slice updates the slice itself so that after | ||
| /// each call the slice only points to the yet unoverwritten part. The slice | ||
| /// will be empty when it has been completely overwritten. | ||
| /// Note that writing updates the slice to point to just the yet unwritten part. |
|
Thanks! Now please squash your commits and it's all good. :) |
GuillaumeGomez
approved these changes
Oct 27, 2016
The Write impls for &[u8] and Vec<u8> are quite different, and we need this to be reflected in the docs. These documentation comments will be visible on the respective type's page in the trait impls section.
|
Updated with the squash. Thanks for the help. |
|
📌 Commit 9568f44 has been approved by |
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Oct 28, 2016
Add documentation for Read, Write impls for slices and Vec The Write imps for &[u8] and Vec<u8> are quite different, and we need this to be reflected in the docs. These documentation comments will be visible on the respective type's page in the trait impls section.
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.
The Write imps for &[u8] and Vec are quite different, and we need this to
be reflected in the docs.
These documentation comments will be visible on the respective type's
page in the trait impls section.