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

Rollup merge of #59528 - DevQps:improve-dbg-macro-docs, r=Centril

Browse source 
Improve the dbg! macro docs

# Description

As stated has been discussed in #58383 the docs do not clearly state why it is useful to have the option to use `dbg!` in release builds as well. This PR should change that.

closes #58383
This commit is contained in:
Mazdak Farrokhzad 2019-03-30 07:51:43 +01:00 committed by GitHub
commit 183afcd8c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/libstd/macros.rs
View file

@ -233,10 +233,14 @@ macro_rules! eprintln {
/// to give up ownership, you can instead borrow with `dbg!(&expr)`
/// for some expression `expr`.
///
/// The `dbg!` macro works exactly the same in release builds.
/// This is useful when debugging issues that only occur in release
/// 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 longer periods.
/// Use cases involving debug output that should be added to version control
/// may be better served by macros such as `debug!` from the `log` crate.
/// are better served by macros such as [`debug!`][debug-log] from the [`log`][log] crate.
///
/// # Stability
///
@ -311,6 +315,8 @@ macro_rules! eprintln {
/// file and line whenever it's reached.
///
/// [stderr]: https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr)
/// [debug-log]: https://docs.rs/log/*/log/macro.debug.html
/// [log]: https://docs.rs/log/
#[macro_export]
#[stable(feature = "dbg_macro", since = "1.32.0")]
macro_rules! dbg {