about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorDirk Gadsden <dirk@esherido.com>2016-01-31 12:33:37 -0800
committerDirk Gadsden <dirk@esherido.com>2016-01-31 20:50:34 -0800
commit76839221ff9bc4fd65ab9e7c0f1cd8e7514446f0 (patch)
treed470886c2e4e113f5477b3bed6cbf2e153977784 /src/libstd
parentcee1695e0839d0672113e7445cec0722559585ee (diff)
downloadrust-76839221ff9bc4fd65ab9e7c0f1cd8e7514446f0.tar.gz
rust-76839221ff9bc4fd65ab9e7c0f1cd8e7514446f0.zip
Minor corrections in docs for `std::process::Child`
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/process.rs10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs
index 2cfbef1e1b7..5e0a54392d2 100644
--- a/src/libstd/process.rs
+++ b/src/libstd/process.rs
@@ -48,13 +48,15 @@ use thread::{self, JoinHandle};
 /// assert!(ecode.success());
 /// ```
 ///
-/// # Safety
+/// # Note
 ///
 /// Take note that there is no implementation of
 /// [`Drop`](../../core/ops/trait.Drop.html) for child processes, so if you
-/// not ensure the `Child` has exited (through `kill`, `wait`, or
-/// `wait_with_output`) then it will continue to run even after the `Child`
-/// handle to it has gone out of scope.
+/// do not ensure the `Child` has exited then it will continue to run, even
+/// after the `Child` handle to the child process has gone out of scope.
+///
+/// Calling `wait` (or other functions that wrap around it) will make the
+/// parent process wait until the child has actually exited before continuing.
 #[stable(feature = "process", since = "1.0.0")]
 pub struct Child {
     handle: imp::Process,