about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2024-02-13 22:51:56 +0100
committerGitHub <noreply@github.com>2024-02-13 22:51:56 +0100
commite499e99a42afeb8117182d52105c3d3db42fca06 (patch)
tree45e2a098c8b2e9b5f4aa6d9676b62d4413380ee8
parent8775df3b1112b99112e44da2be58b0e95d9f1252 (diff)
parentcd3ba4a8852b20ba6aaa55db20bb415d4333c7c7 (diff)
downloadrust-e499e99a42afeb8117182d52105c3d3db42fca06.tar.gz
rust-e499e99a42afeb8117182d52105c3d3db42fca06.zip
Rollup merge of #121046 - camelid:rm-incorrect-compile_fail, r=Nilstrieb
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.rs6
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();
     /// ```
     ///