From 987ae0340fa2c4b22f0ea4b90e9ed3c4692dc28e Mon Sep 17 00:00:00 2001
From: Matt Brubeck <mbrubeck@limpet.net>
Date: Fri, 2 Oct 2015 10:44:44 -0700
Subject: [PATCH] [docs] Use a better example for log_enabled!

The previous example code for the `log_enabled!` macro doesn't properly
demonstrate why to use it, since the use of `log_enabled!` doesn't improve
anything.  (The `debug!` macro already prevents the expensive call when debug
logging is disabled.)
---
 src/macros.rs | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/macros.rs b/src/macros.rs
index e76498a..3a1a487 100644
--- a/src/macros.rs
+++ b/src/macros.rs
@@ -123,10 +123,12 @@ macro_rules! trace {
 ///
 /// # fn foo() {
 /// if log_enabled!(Debug) {
-///     debug!("expensive debug data: {}", expensive_call());
+///     let data = expensive_call();
+///     debug!("expensive debug data: {} {}", data.x, data.y);
 /// }
 /// # }
-/// # fn expensive_call() -> u32 { 0 }
+/// # struct Data { x: u32, y: u32 }
+/// # fn expensive_call() -> Data { Data { x: 0, y: 0 } }
 /// # fn main() {}
 /// ```
 #[macro_export]