diff options
| author | Corey Farwell <coreyf@rwell.org> | 2017-04-20 13:33:12 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-20 13:33:12 -0400 |
| commit | 83e22b8b24c15f7a4b97b62cd53c139e6bb0cb23 (patch) | |
| tree | ec472f4c431df9659c4e7e490a332d0c8bc69f60 /src/libstd | |
| parent | 968ae7babecfc6c62ef9699ff052d9ab00411848 (diff) | |
| parent | df383b95476d59c26e822bcda69d3255da61622c (diff) | |
| download | rust-83e22b8b24c15f7a4b97b62cd53c139e6bb0cb23.tar.gz rust-83e22b8b24c15f7a4b97b62cd53c139e6bb0cb23.zip | |
Rollup merge of #40812 - mgattozzi:ChildDocs, r=steveklabnik
Update `Child` docs to not have a note section In #29370 it's noted that for "the Note shouldn't be one, and should come before the examples." This commit changes the positioning of the section and removes wording that said take note in order for it to flow better with the surrounding text and it's new position.
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/process.rs | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/src/libstd/process.rs b/src/libstd/process.rs index 3795c42f5ef..4ec9076de61 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -73,6 +73,15 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner}; /// spawning process and can itself be constructed using a builder-style /// interface. /// +/// There is no implementation of [`Drop`] for child processes, +/// so if you 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`](#method.wait) (or other functions that wrap around it) will make +/// the parent process wait until the child has actually exited before +/// continuing. +/// /// # Examples /// /// ```should_panic @@ -89,17 +98,6 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner}; /// assert!(ecode.success()); /// ``` /// -/// # Note -/// -/// Take note that there is no implementation of [`Drop`] for child processes, -/// so if you 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`][`wait`] (or other functions that wrap around it) will make -/// the parent process wait until the child has actually exited before -/// continuing. -/// /// [`Command`]: struct.Command.html /// [`Drop`]: ../../core/ops/trait.Drop.html /// [`wait`]: #method.wait |
