Doc bug in Command::stdin?

[roy-work]

Version
1.37.0

Platform
N/A / the documentation

Description

The documentation for Command::stdin reads,

Sets configuration for the child process’s standard input (stdin) handle.

Defaults to inherit when used with spawn or status, and defaults to piped when used with output.

N.b., that this documentation is essentially copy/pasted between stdin, stdout, and stderr, with references to stdin above replaced appropriately; I think this is a bug in that stdin's docs were merely copy/pasted from stdout/stderr without enough thought; in particular, let's look at the second paragraph.

In the second paragraph: assume we call output, which captures the output of the process: why should such a call presume piped as a default for stdin? (It would make sense for stderr and stdout. But stdin?)

If we look at the source for output:

    pub fn output(&mut self) -> impl Future<Output = io::Result<Output>> {
        self.std.stdout(Stdio::piped());
        self.std.stderr(Stdio::piped());

        let child = self.spawn();

        async { child?.wait_with_output().await }
    }
}

… this seems to suggest that stdin is not piped merely by calling Command::output.

I think the behavior is fine, but the docs seem to not relay the correct behavior. This paragraph should probably just be truncated to "Defaults to inherit." for stdin only.

[mox692]

This paragraph should probably just be truncated to "Defaults to inherit." for stdin only.

Such a document update sounds good to me.