[libcatmandu-perl] 28/46: Adding pod about the reject() and select() fix

[Jonas Smedegaard]

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

js pushed a commit to tag 0.9205
in repository libcatmandu-perl.

commit 81362214958ba1d9b8b5c77f3e54b3463023ca3e
Author: Patrick Hochstenbach <patrick.hochstenbach at ugent.be>
Date:   Fri Sep 26 13:08:05 2014 +0200

    Adding pod about the reject() and select() fix
---
 Build.PL                   |  2 +-
 README.md                  | 42 ++++++++++++++++++++++++++++++++++++------
 lib/Catmandu/Fix/reject.pm | 30 ++++++++++++++++++++++++++++++
 3 files changed, 67 insertions(+), 7 deletions(-)

diff --git a/Build.PL b/Build.PL
index ef701cb..2e7ac7b 100644
--- a/Build.PL
+++ b/Build.PL
@@ -1,5 +1,5 @@
 
-# This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v5.016.
+# This file was automatically generated by Dist::Zilla::Plugin::ModuleBuild v5.019.
 use strict;
 use warnings;
 
diff --git a/README.md b/README.md
index 7fb932d..fc5f89a 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Catmandu - a data toolkit
 
     use Catmandu -all;
     use Catmandu qw(config store);
-    use Catmandu -load;
+    use Catmandu -load; # loads default configuration file
     use Catmandu -all -load => [qw(/config/path' '/another/config/path)];
 
     # If you have Catmandu::OAI and Catmandu::MongoDB installed
@@ -274,6 +274,14 @@ Export data using a default or named exporter to a string.
 
     Same as `Catmandu->export_to_string`.
 
+- fixer
+
+    Same as `Catmandu->fixer`.
+
+- log
+
+    Same as `Catmandu->log`.
+
 - -all/:all
 
     Import everything.
@@ -340,11 +348,25 @@ See [Config::Onion](https://metacpan.org/pod/Config::Onion) for more information
 
 # SEE ALSO
 
-[https://github.com/LibreCat/Catmandu/wiki](https://github.com/LibreCat/Catmandu/wiki),
-[Catmandu::Importer](https://metacpan.org/pod/Catmandu::Importer),
-[Catmandu::Exporter](https://metacpan.org/pod/Catmandu::Exporter),
-[Catmandu::Store](https://metacpan.org/pod/Catmandu::Store),
-[Catmandu::Fix](https://metacpan.org/pod/Catmandu::Fix)
+- documentation
+
+    [https://github.com/LibreCat/Catmandu/wiki](https://github.com/LibreCat/Catmandu/wiki)
+
+- command line client
+
+    [catmandu](https://metacpan.org/pod/catmandu)
+
+- core modules
+
+    [Catmandu::Importer](https://metacpan.org/pod/Catmandu::Importer)
+    [Catmandu::Exporter](https://metacpan.org/pod/Catmandu::Exporter),
+    [Catmandu::Store](https://metacpan.org/pod/Catmandu::Store),
+    [Catmandu::Fix](https://metacpan.org/pod/Catmandu::Fix),
+    [Catmandu::Iterable](https://metacpan.org/pod/Catmandu::Iterable)
+
+- extended features
+
+    [Catmandu::Validator](https://metacpan.org/pod/Catmandu::Validator)
 
 # AUTHOR
 
@@ -371,3 +393,11 @@ under the terms of either: the GNU General Public License as published
 by the Free Software Foundation; or the Artistic License.
 
 See [http://dev.perl.org/licenses/](http://dev.perl.org/licenses/) for more information.
+
+# POD ERRORS
+
+Hey! **The above document had some coding errors, which are explained below:**
+
+- Around line 379:
+
+    You forgot a '=back' before '=head1'
diff --git a/lib/Catmandu/Fix/reject.pm b/lib/Catmandu/Fix/reject.pm
index 50ae27d..adc7db3 100644
--- a/lib/Catmandu/Fix/reject.pm
+++ b/lib/Catmandu/Fix/reject.pm
@@ -10,5 +10,35 @@ sub emit {
     $fixer->emit_reject;
 }
 
+=head1 NAME
+
+Catmandu::Fix::reject - remove a record form the data
+
+=head1 SYNOPSIS
+
+  # Reject all items from from the output
+  reject()
+
+  # Reject all items with have an 'ignore_me' field
+  reject exists(ignore_me)
+
+  # Reject all items with have a 'ignore' field with value 'true'
+  reject all_match(ignore,true)
+
+  # Select all items 
+  select()
+
+  # Select only those items that have an 'include_me' field
+  select exists(include_me)
+ 
+  # Select only those items that have an 'include' field with value 'true'
+  select all_match(include,true)
+
+=head1 SEE ALSO
+
+L<Catmandu::Fix>
+
+=cut
+
 1;
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libcatmandu-perl.git