Skip to content

Improve the dbg! macro docs #59528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Improve the dbg! macro docs #59528

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f10e444
Edited the dbg! docs stating that dbg! works the same way in release …
Mar 29, 2019
9240092
Adjusted the indentation.
Mar 29, 2019
fe210d0
Update src/libstd/macros.rs
Centril Mar 29, 2019
8705de4
Update src/libstd/macros.rs
Centril Mar 29, 2019
4c5ef86
Updated the reference style and wording.
Mar 30, 2019
1078cb0
Merge remote-tracking branch 'origin/improve-dbg-macro-docs' into imp…
Mar 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/libstd/macros.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,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
///
Expand Down Expand Up @@ -306,6 +310,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 {
Expand Down