From 69295fac1e9205266e59979591ff5005cf4fe02f Mon Sep 17 00:00:00 2001
From: Alex Crichton <alex@alexcrichton.com>
Date: Sun, 25 Jun 2017 10:36:54 -0700
Subject: [PATCH] process: Add an `Errors` section to `status_async2`

---
 src/lib.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 90c25a555..3962b54e6 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -205,6 +205,12 @@ pub trait CommandExt {
     ///
     /// If the `StatusAsync` future is dropped before the future resolves, then
     /// the child will be killed, if it was spawned.
+    ///
+    /// # Errors
+    ///
+    /// This function will return an error immediately if the child process
+    /// cannot be spawned. Otherwise errors obtained while waiting for the child
+    /// are returned through the `StatusAsync2` future.
     fn status_async2(&mut self, handle: &Handle) -> io::Result<StatusAsync2>;
 
     /// Executes the command as a child process, waiting for it to finish and