Skip to content

Add documentation for Read, Write impls for slices and Vec - #37343

Merged
bors merged 1 commit into
rust-lang:masterfrom
bluss:write-doc
Oct 28, 2016
Merged

Add documentation for Read, Write impls for slices and Vec#37343
bors merged 1 commit into
rust-lang:masterfrom
bluss:write-doc

Conversation

@bluss

@blussbluss commented Oct 22, 2016•
edited
Loading

Copy link
Copy Markdown
Contributor

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.

@rust-highfive

rust-highfive commented Oct 22, 2016

Copy link
Copy Markdown
Contributor

r? @brson

(rust_highfive has picked a reviewer for you, use r? to override)

@bluss
blussforce-pushed the write-doc branch 2 times, most recently from f0414a9 to 6c67764CompareOctober 22, 2016 15:12
GuillaumeGomez
GuillaumeGomez requested changes Oct 27, 2016
View reviewed changes
Comment threadsrc/libstd/io/impls.rs Outdated

@GuillaumeGomezGuillaumeGomezOct 27, 2016

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 sentence is too long and it makes it difficult to read.

Comment threadsrc/libstd/io/impls.rs Outdated

@GuillaumeGomezGuillaumeGomezOct 27, 2016

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.

"when the end of the input"?

@blussblussOct 27, 2016

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.

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?

Comment threadsrc/libstd/io/impls.rs Outdated

@GuillaumeGomezGuillaumeGomezOct 27, 2016

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.

Same, the sentence is too long.

@bluss

bluss commented Oct 27, 2016

Copy link
Copy Markdown
ContributorAuthor

Updated

GuillaumeGomez
GuillaumeGomez reviewed Oct 27, 2016
View reviewed changes
Comment threadsrc/libstd/io/impls.rs Outdated

@GuillaumeGomezGuillaumeGomezOct 27, 2016

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.

"Note that reading updates the slice to point to the yet unread part."? (I removed "just")

@blussblussOct 27, 2016

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.

done!

Comment threadsrc/libstd/io/impls.rs Outdated

@GuillaumeGomezGuillaumeGomezOct 27, 2016

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.

Same as above.

@GuillaumeGomez

GuillaumeGomez commented Oct 27, 2016

Copy link
Copy Markdown
Member

Thanks! Now please squash your commits and it's all good. :)

@bluss
Add documentation for Read, Write impls for slices and Vec
9568f44
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.
@bluss

bluss commented Oct 27, 2016

Copy link
Copy Markdown
ContributorAuthor

Updated with the squash. Thanks for the help.

@GuillaumeGomez

GuillaumeGomez commented Oct 28, 2016

Copy link
Copy Markdown
Member

@bluss: thanks to you!

@bors: r+ rollup

@bors

bors commented Oct 28, 2016

Copy link
Copy Markdown
Collaborator

📌 Commit 9568f44 has been approved by GuillaumeGomez

@GuillaumeGomezGuillaumeGomez mentioned this pull request Oct 28, 2016
Merged
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Oct 28, 2016
@GuillaumeGomez
Rollup merge ofrust-lang#37343- bluss:write-doc, r=GuillaumeGomez
777502e
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.
bors added a commit that referenced this pull request Oct 28, 2016
@bors
Auto merge of#37450- GuillaumeGomez:rollup, r=GuillaumeGomez
421b595
Rollup of 5 pull requests
- Successful merges: #36206, #37343, #37430, #37436, #37441
- Failed merges:
@bors
bors merged commit 9568f44 into rust-lang:masterOct 28, 2016
@bluss
bluss deleted the write-doc branch October 29, 2016 01:01
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GuillaumeGomezGuillaumeGomezGuillaumeGomez approved these changes

Assignees

@brsonbrson

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@bluss@rust-highfive@GuillaumeGomez@bors@brson