diff options
| author | Noah Lev <camelidcamel@gmail.com> | 2024-02-13 14:03:59 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-13 14:03:59 -0500 |
| commit | cd3ba4a8852b20ba6aaa55db20bb415d4333c7c7 (patch) | |
| tree | ea7366e0345c969d49d4ded146093c9791928d58 | |
| parent | eaff1af8fdd18ee3eb05167b2836042b7d4315f6 (diff) | |
| download | rust-cd3ba4a8852b20ba6aaa55db20bb415d4333c7c7.tar.gz rust-cd3ba4a8852b20ba6aaa55db20bb415d4333c7c7.zip | |
Fix incorrect use of `compile_fail`
`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.
| -rw-r--r-- | library/std/src/process.rs | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/library/std/src/process.rs b/library/std/src/process.rs index 4a7f5d8e0be..669affa266a 100644 --- a/library/std/src/process.rs +++ b/library/std/src/process.rs @@ -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(); /// ``` /// @@ -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(); /// ``` /// @@ -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(); /// ``` /// |
