about summary refs log tree commit diff
path: root/clippy_lints/src/write.rs
diff options
context:
space:
mode:
authorPhilipp Krones <hello@philkrones.com>2024-05-30 09:44:14 +0200
committerPhilipp Krones <hello@philkrones.com>2024-05-30 09:44:14 +0200
commit89037ea18f101e2e586feb81d2595a47ae42da46 (patch)
treee5934c662d0ace18bdc16cccb6c2342f69f3e5d7 /clippy_lints/src/write.rs
parentbda742762157d33dc2b2b52c451bcbf4d5237f08 (diff)
parentda4b2127c0a144699b946eec3c8c9d4fd7050c17 (diff)
downloadrust-89037ea18f101e2e586feb81d2595a47ae42da46.tar.gz
rust-89037ea18f101e2e586feb81d2595a47ae42da46.zip
Merge remote-tracking branch 'upstream/master' into rustup
Diffstat (limited to 'clippy_lints/src/write.rs')
-rw-r--r--clippy_lints/src/write.rs13
1 files changed, 8 insertions, 5 deletions
diff --git a/clippy_lints/src/write.rs b/clippy_lints/src/write.rs
index ff6ee0d10ad..652ce88bd95 100644
--- a/clippy_lints/src/write.rs
+++ b/clippy_lints/src/write.rs
@@ -66,7 +66,7 @@ declare_clippy_lint! {
     /// Checks for printing on *stdout*. The purpose of this lint
     /// is to catch debugging remnants.
     ///
-    /// ### Why is this bad?
+    /// ### Why restrict this?
     /// People often print on *stdout* while debugging an
     /// application and might forget to remove those prints afterward.
     ///
@@ -88,7 +88,7 @@ declare_clippy_lint! {
     /// Checks for printing on *stderr*. The purpose of this lint
     /// is to catch debugging remnants.
     ///
-    /// ### Why is this bad?
+    /// ### Why restrict this?
     /// People often print on *stderr* while debugging an
     /// application and might forget to remove those prints afterward.
     ///
@@ -110,15 +110,18 @@ declare_clippy_lint! {
     /// Checks for usage of `Debug` formatting. The purpose of this
     /// lint is to catch debugging remnants.
     ///
-    /// ### Why is this bad?
-    /// The purpose of the `Debug` trait is to facilitate
-    /// debugging Rust code. It should not be used in user-facing output.
+    /// ### Why restrict this?
+    /// The purpose of the `Debug` trait is to facilitate debugging Rust code,
+    /// and [no guarantees are made about its output][stability].
+    /// It should not be used in user-facing output.
     ///
     /// ### Example
     /// ```no_run
     /// # let foo = "bar";
     /// println!("{:?}", foo);
     /// ```
+    ///
+    /// [stability]: https://doc.rust-lang.org/stable/std/fmt/trait.Debug.html#stability
     #[clippy::version = "pre 1.29.0"]
     pub USE_DEBUG,
     restriction,