Skip to content

Commit 5a8619b

Browse files
Rollup merge of #85221 - ijackson:dbg-doc-re-tests, r=joshtriplett
dbg macro: Discuss use in tests, and slightly clarify As discussed in a tangent in #82778. I chose to use [semantic newlines](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) in the source text but I don't mind reformatting it.
2 parents e611e64 + b36a316 commit 5a8619b

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

library/std/src/macros.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -185,9 +185,10 @@ macro_rules! eprintln {
185185
/// builds or when debugging in release mode is significantly faster.
186186
///
187187
/// Note that the macro is intended as a debugging tool and therefore you
188-
/// should avoid having uses of it in version control for long periods.
189-
/// Use cases involving debug output that should be added to version control
190-
/// are better served by macros such as [`debug!`] from the [`log`] crate.
188+
/// should avoid having uses of it in version control for long periods
189+
/// (other than in tests and similar).
190+
/// Debug output from production code is better done with other facilities
191+
/// such as the [`debug!`] macro from the [`log`] crate.
191192
///
192193
/// # Stability
193194
///

0 commit comments

Comments
 (0)