From a173518ceb7ae3b4389a89b1bbb77a1722563cac Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Wed, 12 May 2021 12:09:53 +0100 Subject: [PATCH 1/2] dbg macro: Discuss use in tests, and slightly clarify Signed-off-by: Ian Jackson --- library/std/src/macros.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/library/std/src/macros.rs b/library/std/src/macros.rs index b729349cf530f..9b0a3e74b46c9 100644 --- a/library/std/src/macros.rs +++ b/library/std/src/macros.rs @@ -185,9 +185,10 @@ macro_rules! eprintln { /// builds or when debugging in release mode is significantly faster. /// /// Note that the macro is intended as a debugging tool and therefore you -/// should avoid having uses of it in version control for long periods. -/// Use cases involving debug output that should be added to version control -/// are better served by macros such as [`debug!`] from the [`log`] crate. +/// should avoid having uses of it in version control for long periods +/// (other than in tests etc.) +/// Debug output from production code is better done with other facilities +/// such as the [`debug!`] macro from the [`log`] crate. /// /// # Stability /// From b36a3162fed680067a4985641856be295a328a75 Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Thu, 13 May 2021 15:02:02 +0100 Subject: [PATCH 2/2] Change "etc." to "and similar" Co-authored-by: Josh Triplett --- library/std/src/macros.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library/std/src/macros.rs b/library/std/src/macros.rs index 9b0a3e74b46c9..b2c5df5410dca 100644 --- a/library/std/src/macros.rs +++ b/library/std/src/macros.rs @@ -186,7 +186,7 @@ macro_rules! eprintln { /// /// Note that the macro is intended as a debugging tool and therefore you /// should avoid having uses of it in version control for long periods -/// (other than in tests etc.) +/// (other than in tests and similar). /// Debug output from production code is better done with other facilities /// such as the [`debug!`] macro from the [`log`] crate. ///