diff options
| author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2021-05-12 12:09:53 +0100 |
|---|---|---|
| committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2021-05-12 12:09:53 +0100 |
| commit | a173518ceb7ae3b4389a89b1bbb77a1722563cac (patch) | |
| tree | c3c5f94fff8571fefde4459977d7ff065ded08f7 | |
| parent | 2fb1dee14b3eff979f91e99ad034cfe262fc78c3 (diff) | |
| download | rust-a173518ceb7ae3b4389a89b1bbb77a1722563cac.tar.gz rust-a173518ceb7ae3b4389a89b1bbb77a1722563cac.zip | |
dbg macro: Discuss use in tests, and slightly clarify
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
| -rw-r--r-- | library/std/src/macros.rs | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/library/std/src/macros.rs b/library/std/src/macros.rs index b729349cf53..9b0a3e74b46 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 /// |
