From: Matt S Trout <matthewt@hercule.scsys.co.uk>
Date: Mon, 5 Oct 2009 16:41:26 +0000 (+0100)
Subject: more explanation of purpose, limitations and alternatives in the POD
X-Git-Tag: v2.000~21
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=739397239c2f69a006bfcaa8a6d418c611cd34b8;p=p5sagit%2FData-Dumper-Concise.git

more explanation of purpose, limitations and alternatives in the POD
---

diff --git a/Changes b/Changes
index 2e67581..7391ea7 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,5 @@
+  - more explanation of purpose, limitations and alternatives in the POD
+
 1.000 Oct 3 2009
   - Dumper() returns concise Data::Dumper object
   - Dumper($ref) returns concisely dumped ref
diff --git a/lib/Data/Dumper/Concise.pm b/lib/Data/Dumper/Concise.pm
index 5f91e5f..66ab409 100644
--- a/lib/Data/Dumper/Concise.pm
+++ b/lib/Data/Dumper/Concise.pm
@@ -95,6 +95,13 @@ It exists, fundamentally, as a convenient way to reproduce a set of Dumper
 options that we've found ourselves using across large numbers of applications,
 primarily for debugging output.
 
+The principle guiding theme is "all the concision you can get while still
+having a useful dump and not doing anything cleverer than setting Data::Dumper
+options" - it's been pointed out to us that Data::Dump::Streamer can produce
+shorter output with less lines of code. We know. This is simpler and we've
+never seen it segfault. But for complex/weird structures, it generally rocks.
+You should use it as well, when Concise is underkill. We do.
+
 Why is deparsing on when the aim is concision? Because you often want to know
 what subroutine refs you have when debugging and because if you were planning
 to eval this back in you probably wanted to remove subrefs first and add them
@@ -102,6 +109,22 @@ back in a custom way anyway. Note that this -does- force using the pure perl
 Dumper rather than the XS one, but I've never in my life seen Data::Dumper
 show up in a profile so "who cares?".
 
+=head1 BUT BUT BUT ...
+
+Yes, we know. Consider this module in the ::Tiny spirit and feel free to
+write a Data::Dumper::Concise::ButWithExtraTwiddlyBits if it makes you
+happy. Then tell us so we can add it to the see also section.
+
+=head1 SEE ALSO
+
+We use for some purposes, and dearly love, the following alternatives:
+
+L<Data::Dump> - prettiness oriented but not amazingly configurable
+
+L<Data::Dump::Streamer> - brilliant. beautiful. insane. extensive. excessive. try it.
+
+L<JSON::XS> - no, really. If it's just plain data, JSON is a great option.
+
 =head1 AUTHOR
 
 Matt S. Trout <mst@shadowcat.co.uk>