[libdist-zilla-util-configdumper-perl] 07/09: Enhance DESCRIPTION as per #3

[Florian Schlichting]

This is an automated email from the git hooks/post-receive script.

fsfs pushed a commit to annotated tag 0.003007-source
in repository libdist-zilla-util-configdumper-perl.

commit aab31162a76b8e3c56c20b6ed09e0dfdc8558ceb
Author: Kent Fredric <kentfredric at gmail.com>
Date:   Fri Jul 31 15:36:27 2015 +1200

    Enhance DESCRIPTION as per #3
---
 Changes                             |  3 +++
 README.mkdn                         | 16 ++++++++++++++++
 lib/Dist/Zilla/Util/ConfigDumper.pm | 22 ++++++++++++++++++++++
 maint/perlcritic.rc.gen.pl          |  2 +-
 perlcritic.rc                       |  6 +++---
 5 files changed, 45 insertions(+), 4 deletions(-)

diff --git a/Changes b/Changes
index 9f13351..219f9d5 100644
--- a/Changes
+++ b/Changes
@@ -7,6 +7,9 @@ Release history for Dist-Zilla-Util-ConfigDumper
  - develop: +12 ↑3 -3 (recommends: +1, suggests: ↑2)
  - test: +1 (recommends: +1 ↑1 ↓1)
 
+ [Documentation]
+ - Enhance DESCRIPTION section as per request #3
+
 0.003006 2014-10-02T04:27:34Z
  [Bugfix]
  - Require 1.(0x5)3, as versions prior to that can fail due to a missing dependency on an appropriate role.
diff --git a/README.mkdn b/README.mkdn
index 3fe5d85..334ab8d 100644
--- a/README.mkdn
+++ b/README.mkdn
@@ -15,6 +15,22 @@ version 0.003007
 
     around dump_config => config_dumper( __PACKAGE__, qw( foo bar baz ) );
 
+# DESCRIPTION
+
+This module contains a utility function for use within the `Dist::Zilla`
+plugin ecosystem, to simplify extraction of plugin settings for plugin
+authors, in order for plugins like `Dist::Zilla::Plugin::MetaConfig` to expose
+those values to consumers.
+
+Primarily, it specializes in:
+
+- Making propagating configuration from the plugins inheritance hierarchy
+nearly foolproof.
+- Providing simple interfaces to extract values of lists of named methods
+or accessors
+- Providing a way to intelligently and easily probe the value of lazy
+attributes without triggering their vivification.
+
 # FUNCTIONS
 
 ## `config_dumper`
diff --git a/lib/Dist/Zilla/Util/ConfigDumper.pm b/lib/Dist/Zilla/Util/ConfigDumper.pm
index e93be55..27095a8 100644
--- a/lib/Dist/Zilla/Util/ConfigDumper.pm
+++ b/lib/Dist/Zilla/Util/ConfigDumper.pm
@@ -194,6 +194,28 @@ sub _mk_test {
 
   around dump_config => config_dumper( __PACKAGE__, qw( foo bar baz ) );
 
+=head1 DESCRIPTION
+
+This module contains a utility function for use within the C<Dist::Zilla>
+plugin ecosystem, to simplify extraction of plugin settings for plugin
+authors, in order for plugins like C<Dist::Zilla::Plugin::MetaConfig> to expose
+those values to consumers.
+
+Primarily, it specializes in:
+
+=over 4
+
+=item * Making propagating configuration from the plugins inheritance hierarchy
+nearly foolproof.
+
+=item * Providing simple interfaces to extract values of lists of named methods
+or accessors
+
+=item * Providing a way to intelligently and easily probe the value of lazy
+attributes without triggering their vivification.
+
+=back
+
 =head1 ADVANCED USE
 
 =head2 CALLBACKS
diff --git a/maint/perlcritic.rc.gen.pl b/maint/perlcritic.rc.gen.pl
index 6d8d186..c240525 100644
--- a/maint/perlcritic.rc.gen.pl
+++ b/maint/perlcritic.rc.gen.pl
@@ -18,7 +18,7 @@ use Path::Tiny qw(path);
 my $bundle = create_bundle('Example::Author::KENTNL');
 $bundle->configure;
 
-my @stopwords = (qw(dumpconfig));
+my @stopwords = (qw(dumpconfig accessors vivification));
 for my $wordlist (@stopwords) {
   $bundle->add_or_append_policy_field( 'Documentation::PodSpelling' => ( 'stop_words' => $wordlist ) );
 }
diff --git a/perlcritic.rc b/perlcritic.rc
index d88731f..e21f436 100644
--- a/perlcritic.rc
+++ b/perlcritic.rc
@@ -88,7 +88,7 @@ allow_includes = 1
 
 [CodeLayout::RequireTrailingCommas]
 
-[CodeLayout::RequireUseUTF8]
+[-CodeLayout::RequireUseUTF8]
 
 [Compatibility::ConstantLeadingUnderscore]
 
@@ -126,7 +126,7 @@ allow_includes = 1
 
 [Documentation::PodSpelling]
 spell_command = aspell list --lang en_US
-stop_words = dumpconfig
+stop_words = dumpconfig accessors vivification
 
 [Documentation::ProhibitAdjacentLinks]
 
@@ -305,7 +305,7 @@ allowed_pragmata = diagnostics feature perlversion strict warnings utf8
 
 [RegularExpressions::RequireExtendedFormatting]
 
-[RegularExpressions::RequireLineBoundaryMatching]
+[-RegularExpressions::RequireLineBoundaryMatching]
 
 [Subroutines::ProhibitAmpersandSigils]
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libdist-zilla-util-configdumper-perl.git