]> Cypherpunks repositories - gostls13.git/commitdiff
os/exec: simplify doc wording for cmd.StdoutPipe and cmd.StderrPipe
authorJosh Bleecher Snyder <josharian@gmail.com>
Thu, 3 Oct 2019 21:06:08 +0000 (14:06 -0700)
committerJosh Bleecher Snyder <josharian@gmail.com>
Fri, 4 Oct 2019 00:22:44 +0000 (00:22 +0000)
The existing text was hard to parse.
Shorten the sentences and simplify the text.

Change-Id: Ic16f486925090ea303c04e70969e5a4b27a60896
Reviewed-on: https://go-review.googlesource.com/c/go/+/198758
Reviewed-by: Ian Lance Taylor <iant@golang.org>
src/os/exec/exec.go

index 17ef003eca02b435019b7d9ce5cfbd8028e76c9c..19c7e2406abb3b9c25e12f1c5ad56257cb5c7ddb 100644 (file)
@@ -606,8 +606,8 @@ func (c *closeOnce) close() {
 // standard output when the command starts.
 //
 // Wait will close the pipe after seeing the command exit, so most callers
-// need not close the pipe themselves; however, an implication is that
-// it is incorrect to call Wait before all reads from the pipe have completed.
+// need not close the pipe themselves. It is thus incorrect to call Wait
+// before all reads from the pipe have completed.
 // For the same reason, it is incorrect to call Run when using StdoutPipe.
 // See the example for idiomatic usage.
 func (c *Cmd) StdoutPipe() (io.ReadCloser, error) {
@@ -631,8 +631,8 @@ func (c *Cmd) StdoutPipe() (io.ReadCloser, error) {
 // standard error when the command starts.
 //
 // Wait will close the pipe after seeing the command exit, so most callers
-// need not close the pipe themselves; however, an implication is that
-// it is incorrect to call Wait before all reads from the pipe have completed.
+// need not close the pipe themselves. It is thus incorrect to call Wait
+// before all reads from the pipe have completed.
 // For the same reason, it is incorrect to use Run when using StderrPipe.
 // See the StdoutPipe example for idiomatic usage.
 func (c *Cmd) StderrPipe() (io.ReadCloser, error) {