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

Add links and examples for std::process::Stdio #45106

Merged
merged 2 commits into from Oct 10, 2017

Conversation

mistodon
Copy link

@mistodon mistodon commented Oct 8, 2017

As per #29370

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @dtolnay (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. Due to 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.

/// Describes what to do with a standard I/O stream for a child process when
/// passed to the [`stdin`], [`stdout`], and [`stderr`] methods of [`Command`].
///
/// [`stdin`]: ./struct.Command.html#method.stdin
Copy link
Member

Choose a reason for hiding this comment

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

I don't know much about rustdoc but these are the only instances of grep -r '\./struct' in the whole repo. Could you check whether other docs use a different style for links?

Copy link
Author

Choose a reason for hiding this comment

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

Sure, I'll take a look and I'll fix the trailing whitespace.

@dtolnay
Copy link
Member

dtolnay commented Oct 8, 2017

[00:04:33] tidy error: /checkout/src/libstd/process.rs:786: trailing whitespace
[00:04:33] tidy error: /checkout/src/libstd/process.rs:791: trailing whitespace
[00:04:33] tidy error: /checkout/src/libstd/process.rs:821: trailing whitespace
[00:04:33] tidy error: /checkout/src/libstd/process.rs:827: trailing whitespace
[00:04:33] tidy error: /checkout/src/libstd/process.rs:857: trailing whitespace
[00:04:33] tidy error: /checkout/src/libstd/process.rs:863: trailing whitespace
[00:04:34] some tidy checks failed

Also remove trailing whitespace to pass tidy checks.
@mistodon
Copy link
Author

mistodon commented Oct 8, 2017

Judging by other examples in the docs, the ./ prefix isn't used, so I've removed it. Also fixed the tidy errors.

@dtolnay
Copy link
Member

dtolnay commented Oct 8, 2017

Thanks! Great work on these examples.

@bors r+

@bors
Copy link
Contributor

bors commented Oct 8, 2017

📌 Commit 9772003 has been approved by dtolnay

@carols10cents carols10cents added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Oct 9, 2017
kennytm added a commit to kennytm/rust that referenced this pull request Oct 9, 2017
Add links and examples for std::process::Stdio

As per rust-lang#29370
bors added a commit that referenced this pull request Oct 10, 2017
Rollup of 9 pull requests

- Successful merges: #44962, #45051, #45091, #45106, #45117, #45118, #45120, #45125, #45136
- Failed merges:
@bors bors merged commit 9772003 into rust-lang:master Oct 10, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants