Skip to content
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

Removed rustdoc comments on pub mod statements in std::io's mod.rs. Twea... #12490

Merged
merged 1 commit into from
Feb 26, 2014

Conversation

zslayton
Copy link
Contributor

Attn: @huonw

Addresses #12386.

@@ -300,46 +300,46 @@ pub use self::buffered::{BufferedReader, BufferedWriter, BufferedStream,
LineBufferedWriter};
pub use self::comm_adapters::{PortReader, ChanWriter};

/// Various utility functions useful for writing I/O tests
// Various utility functions useful for writing I/O tests
Copy link
Member

Choose a reason for hiding this comment

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

Can you move this comment inside the module?

@alexcrichton
Copy link
Member

I'd also be find with deleting these doc-comments instead of just making them comments.

@zslayton
Copy link
Contributor Author

@alexcrichton Done!

…od.rs file. Added summary doc-comments to test.rs, util.rs and stdio.rs.
@alexcrichton
Copy link
Member

This appears to have picked up a few extra commits. I would recommend using git rebase instead of git merge to get a clean history.

@zslayton
Copy link
Contributor Author

Shoot. It would seem that I'm not very talented at rebasing. I was trying to do that when I somehow created the merge commits.

I have a master branch and this bugfix branch, 'doc-fix-12386'. Mozilla's repo is my upstream.

Whenever I run git rebase upstream/master from my doc fix branch, I get a bunch of conflicts listed for files that I didn't touch. (i.e. files outside of src/libstd/io). I'm afraid that I'm not sure how to resolve them -- can I just rebase with -Xtheirs? Or is that dangerous?

@zslayton zslayton closed this Feb 24, 2014
@zslayton zslayton reopened this Feb 24, 2014
@alexcrichton
Copy link
Member

It may have been the case that you just needed to start a new branch and cherry-pick your one commit on top, but I'm not entirely sure. Regardless, it seems to have been sorted out!

Sorry I forgot to mention this earlier, but could you also mention the issue in the commit message itself? If you phrase it like Closes #XXXX github will auto-close the issue when this PR is merged.

@zslayton
Copy link
Contributor Author

Sure, I'd be happy to. It's not possible to change the commit message once it's been pushed, is it? How do you recommend I amend it?

@zslayton
Copy link
Contributor Author

Nevermind, I just reset the branch and reapplied my changes with the new message.

@alexcrichton
Copy link
Member

You can also use git commit --amend plus a force-push to change a commit message.

@zslayton
Copy link
Contributor Author

Oh! Educational. Thanks!

On Sun, Feb 23, 2014 at 11:47 PM, Alex Crichton notifications@github.comwrote:

You can also use git commit --amend plus a force-push to change a commit
message.

Reply to this email directly or view it on GitHubhttps://github.com//pull/12490#issuecomment-35857620
.

bors added a commit that referenced this pull request Feb 26, 2014
@bors bors closed this Feb 26, 2014
@bors bors merged commit 90f2d1d into rust-lang:master Feb 26, 2014
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 25, 2022
…, r=Veykril

fix: complete non-std enum at the start of `use` completions

close: rust-lang#12421
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.

None yet

3 participants