document DwarnL and ::Dwarn

[p5sagit/Data-Dumper-Concise.git] / lib / Devel / Dwarn.pm

diff --git a/lib/Devel/Dwarn.pm b/lib/Devel/Dwarn.pm
index c522a11..7f32a10 100644 (file)
--- a/lib/Devel/Dwarn.pm
+++ b/lib/Devel/Dwarn.pm
@@ -11,8 +11,7 @@ sub import {
 Devel::Dwarn - return Dwarn @return_value
 
 =head1 SYNOPSIS
-
-  use Devel::Dwarn;
+  use Data::Dumper::Concise::Sugar;
 
   return Dwarn some_call(...)
 
@@ -20,13 +19,19 @@ is equivalent to:
 
   use Data::Dumper::Concise;
 
-  my @return = some_call(...);
-  warn Dumper(@return);
-  return @return;
+  if (wantarray) {
+     my @return = some_call(...);
+     warn Dumper(@return);
+     return @return;
+  } else {
+     my $return = some_call(...);
+     warn Dumper($return);
+     return $return;
+  }
 
 but shorter. If you need to force scalar context on the value,
 
-  use Devel::Dwarn;
+  use Data::Dumper::Concise::Sugar;
 
   return DwarnS some_call(...)
 
@@ -38,8 +43,45 @@ is equivalent to:
   warn Dumper($return);
   return $return;
 
-Another trick that is extremely useful when doing method chaining is the
-following:
+If you need to force list context on the value,
+
+  use Data::Dumper::Concise::Sugar;
+
+  return DwarnL some_call(...)
+
+is equivalent to:
+
+  use Data::Dumper::Concise;
+
+  my @return = some_call(...);
+  warn Dumper(@return);
+  return @return;
+
+=head1 TIPS AND TRICKS
+
+=head2 global usage
+
+Instead of always just doing:
+
+  use Devel::Dwarn;
+
+  Dwarn ...
+
+We tend to do:
+
+  perl -MDevel::Dwarn foo.pl
+
+(and then in the perl code:)
+
+  ::Dwarn ...
+
+That way, if you leave them in and run without the C<< use Devel::Dwarn >>
+the program will fail to compile and you are less likely to check it in by
+accident.  Furthmore it allows that much less friction to add debug messages.
+
+=head2 method chaining
+
+One trick which is useful when doing method chaining is the following:
 
   my $foo = Bar->new;
   $foo->bar->baz->Devel::Dwarn::DwarnS->biff;