diff options
| author | Michael Gattozzi <mgattozzi@gmail.com> | 2017-03-24 23:29:23 -0400 |
|---|---|---|
| committer | Michael Gattozzi <mgattozzi@gmail.com> | 2017-03-24 23:29:23 -0400 |
| commit | bde6336976f9a660fb9b14b89316ade85837fe44 (patch) | |
| tree | 8ae52660bbcab955e8aaac42a32cef09af345a98 | |
| parent | 3da40237e542e7859adab48049ec15cf18154817 (diff) | |
| download | rust-bde6336976f9a660fb9b14b89316ade85837fe44.tar.gz rust-bde6336976f9a660fb9b14b89316ade85837fe44.zip | |
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.
| -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 7a85e588662..293c8501400 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`][`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 |