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

Edited the dbg! docs stating that dbg! works the same way in release builds.

Browse source
This commit is contained in:
Christian 2019-03-29 15:56:22 +01:00
parent cd45b19bd2
commit f10e44420a
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
src/libstd/macros.rs
View file

@ -231,10 +231,13 @@ 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
///
@ -306,6 +309,8 @@ macro_rules! eprintln {
/// ```
///
/// [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 {