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

docs: stdin is always inherit by default #6581

Merged
merged 1 commit into from
May 23, 2024
Merged

docs: stdin is always inherit by default #6581

merged 1 commit into from
May 23, 2024

Conversation

roy-work
Copy link
Contributor

The code for output indicates that only sets stdout and stderr (as one would expect, IMO), yet the docs for stdin indicated that it too would be set. This seems like it was just a simple copy/paste typo, so correct stdin to note that it just defaults to inherit.

Fixes #6577.

Motivation

See #6577; the docs for stdin seem to disagree with the code for output.

Solution

Adjust the documentation to match the code.

The code for `output` indicates that only sets `stdout` and `stderr` (as
one would expect, IMO), yet the docs for `stdin` indicated that it too
would be set. This seems like it was just a simple copy/paste typo, so
correct `stdin` to note that it just defaults to `inherit`.

Fixes #6577.
Copy link
Member

@mox692 mox692 left a comment

Choose a reason for hiding this comment

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

Thank you!

@mox692 mox692 merged commit 16ef7b1 into tokio-rs:master May 23, 2024
77 checks passed
@roy-work roy-work deleted the stdin-docs branch May 24, 2024 16:19
@Darksonn Darksonn added A-tokio Area: The main tokio crate M-process Module: tokio/process labels May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-process Module: tokio/process
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc bug in Command::stdin?
3 participants