Skip to content

Commit 83e22b8

Browse files
authored
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.
2 parents 968ae7b + df383b9 commit 83e22b8

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

src/libstd/process.rs

+9-11
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
7373
/// spawning process and can itself be constructed using a builder-style
7474
/// interface.
7575
///
76+
/// There is no implementation of [`Drop`] for child processes,
77+
/// so if you do not ensure the `Child` has exited then it will continue to
78+
/// run, even after the `Child` handle to the child process has gone out of
79+
/// scope.
80+
///
81+
/// Calling [`wait`](#method.wait) (or other functions that wrap around it) will make
82+
/// the parent process wait until the child has actually exited before
83+
/// continuing.
84+
///
7685
/// # Examples
7786
///
7887
/// ```should_panic
@@ -89,17 +98,6 @@ use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
8998
/// assert!(ecode.success());
9099
/// ```
91100
///
92-
/// # Note
93-
///
94-
/// Take note that there is no implementation of [`Drop`] for child processes,
95-
/// so if you do not ensure the `Child` has exited then it will continue to
96-
/// run, even after the `Child` handle to the child process has gone out of
97-
/// scope.
98-
///
99-
/// Calling [`wait`][`wait`] (or other functions that wrap around it) will make
100-
/// the parent process wait until the child has actually exited before
101-
/// continuing.
102-
///
103101
/// [`Command`]: struct.Command.html
104102
/// [`Drop`]: ../../core/ops/trait.Drop.html
105103
/// [`wait`]: #method.wait

0 commit comments

Comments
 (0)