Skip to content

std: small doc fixes for BufReader and BufWriter #26784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2015

Conversation

birkenfeld
Copy link
Contributor

  • fix probable copy-paste error in BufWriter.get_mut()
  • more consistent punctuation

* fix probable copy-paste error in BufWriter.get_mut()
* more consistent punctuation
@rust-highfive
Copy link
Contributor

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @huonw (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@@ -21,7 +21,7 @@ use io::{self, DEFAULT_BUF_SIZE, Error, ErrorKind, SeekFrom};
use ptr;
use iter;

/// Wraps a `Read` and buffers input from it
/// Wraps a `Read` and buffers input from it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convention is to use full sentences, actually, so I'd prefer to leave this (and others)

@steveklabnik
Copy link
Member

Thanks @birkenfeld ! I'll take the typo fixes, but the periods should stay.

@birkenfeld
Copy link
Contributor Author

I don't understand - I'm adding the periods, which are also present in the first sentences of other docstrings in this file.

@huonw
Copy link
Member

huonw commented Jul 8, 2015

r? @steveklabnik

@rust-highfive rust-highfive assigned steveklabnik and unassigned huonw Jul 8, 2015
@steveklabnik
Copy link
Member

@birkenfeld sorry! I guess I read the diff backwards. Periods are what we want, for sure.

@steveklabnik
Copy link
Member

@bors: r+ rollup

@bors
Copy link
Collaborator

bors commented Jul 8, 2015

📌 Commit df73abe has been approved by steveklabnik

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 8, 2015
* fix probable copy-paste error in BufWriter.get_mut()
* more consistent punctuation
bors added a commit that referenced this pull request Jul 8, 2015
@bors bors merged commit df73abe into rust-lang:master Jul 8, 2015
@birkenfeld birkenfeld deleted the patch-2 branch August 20, 2015 05:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants