squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Rollup merge of #85221 - ijackson:dbg-doc-re-tests, r=joshtriplett

Browse source 
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.
This commit is contained in:
Guillaume Gomez 2021-05-15 13:29:50 +02:00 committed by GitHub
parent e611e64e3a b36a3162fe
commit 5a8619b435
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
library/std/src/macros.rs
View file

@ -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 and similar).
/// Debug output from production code is better done with other facilities
/// such as the [`debug!`] macro from the [`log`] crate.
///
/// # Stability
///