Rollup merge of #100839 - nelsonjchen:consistent_child_stdin_field_desc, r=thomcc

Make doc for stdin field of process consistent

The other fields use this format and example.
This commit is contained in:
Matthias Krüger 2022-08-21 16:54:08 +02:00 committed by GitHub
commit 5e761f3f03
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -169,15 +169,15 @@ use crate::sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
pub struct Child {
pub(crate) handle: imp::Process,
/// The handle for writing to the child's standard input (stdin), if it has
/// been captured. To avoid partially moving
/// the `child` and thus blocking yourself from calling
/// functions on `child` while using `stdin`,
/// you might find it helpful:
/// The handle for writing to the child's standard input (stdin), if it
/// has been captured. You might find it helpful to do
///
/// ```compile_fail,E0425
/// let stdin = child.stdin.take().unwrap();
/// ```
///
/// to avoid partially moving the `child` and thus blocking yourself from calling
/// functions on `child` while using `stdin`.
#[stable(feature = "process", since = "1.0.0")]
pub stdin: Option<ChildStdin>,