Skip to content

Commit

Permalink
Fix incorrect use of compile_fail
Browse files Browse the repository at this point in the history
`compile_fail` should only be used when the code is meant to show
what *not* to do. In other words, there should be a fundamental flaw
in the code. However, in this case, the example is just incomplete,
so we should use `ignore` to avoid confusing readers.
  • Loading branch information
camelid authored Feb 13, 2024
1 parent eaff1af commit cd3ba4a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions library/std/src/process.rs
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ pub struct Child {
/// 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
/// ```ignore (incomplete)
/// let stdin = child.stdin.take().unwrap();
/// ```
///
Expand All @@ -183,7 +183,7 @@ pub struct Child {
/// The handle for reading from the child's standard output (stdout), if it
/// has been captured. You might find it helpful to do
///
/// ```compile_fail,E0425
/// ```ignore (incomplete)
/// let stdout = child.stdout.take().unwrap();
/// ```
///
Expand All @@ -195,7 +195,7 @@ pub struct Child {
/// The handle for reading from the child's standard error (stderr), if it
/// has been captured. You might find it helpful to do
///
/// ```compile_fail,E0425
/// ```ignore (incomplete)
/// let stderr = child.stderr.take().unwrap();
/// ```
///
Expand Down

0 comments on commit cd3ba4a

Please sign in to comment.