about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorMichael Gattozzi <mgattozzi@gmail.com>2017-03-25 17:19:36 -0400
committerMichael Gattozzi <mgattozzi@gmail.com>2017-03-25 17:19:36 -0400
commit1d59c67942ea682d0de4bb847d6da38d6417e07d (patch)
treebe81bae9695611ec0ec0e8e764e2c1139403a0d1 /src
parent3da40237e542e7859adab48049ec15cf18154817 (diff)
downloadrust-1d59c67942ea682d0de4bb847d6da38d6417e07d.tar.gz
rust-1d59c67942ea682d0de4bb847d6da38d6417e07d.zip
Update ChildStderr docs to be clearer
Before the docs only had a line about where it was found and that it was
a handle to stderr. This commit changes it so that the summary second line is
removed and that it's a bit clearer about what can be done with it. Part of
\#29370
Diffstat (limited to 'src')
-rw-r--r--src/libstd/process.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index 7a85e588662..265228281f8 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -233,8 +233,9 @@ impl fmt::Debug for ChildStdout {
     }
 }
 
-/// A handle to a child process's stderr. This struct is used in the [`stderr`]
-/// field on [`Child`].
+/// A handle to a child process's stderr. It can be used to
+/// read any errors that the child process has output while
+/// running.
 ///
 /// [`Child`]: struct.Child.html
 /// [`stderr`]: struct.Child.html#structfield.stderr