[libcatmandu-marc-perl] 87/208: Fixing POD documentation

Jonas Smedegaard dr at jones.dk
Sat Oct 28 03:42:38 UTC 2017


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

js pushed a commit to annotated tag upstream/1.19
in repository libcatmandu-marc-perl.

commit fe0afeb886554c176a02bcd9062484e175ff4b59
Author: Patrick Hochstenbach <patrick.hochstenbach at ugent.be>
Date:   Mon Jan 30 16:33:10 2017 +0100

    Fixing POD documentation
---
 lib/Catmandu/Exporter/MARC.pm | 32 +++++++++++++++++++-----------
 lib/Catmandu/Importer/MARC.pm | 45 ++++++++++++++++++++++++++++---------------
 2 files changed, 51 insertions(+), 26 deletions(-)

diff --git a/lib/Catmandu/Exporter/MARC.pm b/lib/Catmandu/Exporter/MARC.pm
index b465d56..1ff43e8 100644
--- a/lib/Catmandu/Exporter/MARC.pm
+++ b/lib/Catmandu/Exporter/MARC.pm
@@ -43,7 +43,7 @@ Catmandu::Exporter::MARC - Exporter for MARC records
     $ catmandu convert MARC --type ISO to MARC --type XML < /foo/bar.mrc
 
     # From Perl
-    use Catmandui -all;
+    use Catmandu 'all';
 
     my $importer = importer('MARC', file => "/foo/bar.mrc" , type => 'ISO');
     my $exporter = exporter('MARC', file => "marc.xml", type => "XML" );
@@ -61,26 +61,36 @@ to a file or the standard output.
 In addition to the configuration provided by L<Catmandu::Exporter> (C<file>,
 C<fh>, etc.) the exporter can be configured with the following parameters:
 
+The 'type' parameter describes the MARC syntax variant. Supported values include:
+
 =over
 
-=item type
+=item
 
-Describes the MARC syntax variant. Supported values include:
+ISO: L<Catmandu::Exporter::MARC::ISO> (default)
 
-=over
+=item
 
-=item * ISO: L<Catmandu::Exporter::MARC::ISO> (default)
+XML: L<Catmandu::Exporter::MARC::XML>
 
-=item * XML: L<Catmandu::Exporter::MARC::XML>
+=item
 
-=item * MARCMaker: L<Catmandu::Exporter::MARC::MARCMaker>
+MARCMaker: L<Catmandu::Exporter::MARC::MARCMaker>
 
-=item * MiJ: L<Catmandu::Exporter::MARC::MiJ> (MARC in JSON)
+=item
 
-=item * ALEPHSEQ: L<Catmandu::Exporter::MARC::ALEPHSEQ>
+MiJ: L<Catmandu::Exporter::MARC::MiJ> (MARC in JSON)
 
-=head1 SEE ALSO
+=item
 
-L<Catmandu::Importer::MARC>
+ALEPHSEQ: L<Catmandu::Exporter::MARC::ALEPHSEQ>
 
 =back
+
+    E.g.
+
+    catmandu convert MARC --type XML to MARC --type ISO < marc.xml > marc.iso
+    
+=head1 SEE ALSO
+
+L<Catmandu::Importer::MARC>
diff --git a/lib/Catmandu/Importer/MARC.pm b/lib/Catmandu/Importer/MARC.pm
index 1a89307..4b9d401 100644
--- a/lib/Catmandu/Importer/MARC.pm
+++ b/lib/Catmandu/Importer/MARC.pm
@@ -62,7 +62,7 @@ Catmandu::Importer::MARC - Package that imports MARC data
         printf "title: %s\n" , $record->{title};
     });
 
-Convert MARC to JSON mapping 245a to a title with the L<catmandu> command line client:
+    # Convert MARC to JSON mapping 245a to a title with the L<catmandu> command line client:
 
     catmandu convert MARC --fix "marc_map('245a','title')" < /foo/bar.mrc
 
@@ -83,7 +83,7 @@ an ARRAY of ARRAYs containing the record data
 
 =back
 
-=head2 EXAMPLE ITEM
+=head1 EXAMPLE ITEM
 
  {
     record => [
@@ -117,34 +117,49 @@ L<Catmandu::Iterable>.
 In addition to the configuration provided by L<Catmandu::Importer> (C<file>,
 C<fh>, etc.) the importer can be configured with the following parameters:
 
+
+The 'type' parameter describes the MARC syntax variant. Supported values include:
+
 =over
 
-=item type
+=item
 
-Describes the MARC syntax variant. Supported values include:
+ISO: L<Catmandu::Importer::MARC::ISO> (default)
 
-=over
+=item
+
+MicroLIF: L<Catmandu::Importer::MARC::MicroLIF>
+
+=item
+
+MARCMaker: L<Catmandu::Importer::MARC::MARCMaker>
 
-=item * ISO: L<Catmandu::Importer::MARC::ISO> (default)
+=item
 
-=item * MicroLIF: L<Catmandu::Importer::MARC::MicroLIF>
+MiJ: L<Catmandu::Importer::MARC::MiJ> (MARC in JSON)
 
-=item * MARCMaker: L<Catmandu::Importer::MARC::MARCMaker>
+=item
 
-=item * MiJ: L<Catmandu::Importer::MARC::MiJ> (MARC in JSON)
+XML: L<Catmandu::Importer::MARC::XML>
 
-=item * XML: L<Catmandu::Importer::MARC::XML>
+=item
 
-=item * RAW: L<Catmandu::Importer::MARC::RAW>
+RAW: L<Catmandu::Importer::MARC::RAW>
 
-=item * Lint: L<Catmandu::Importer::MARC::Lint>
+=item
 
-=item * ALEPHSEQ: L<Catmandu::Importer::MARC::ALEPHSEQ>
+Lint: L<Catmandu::Importer::MARC::Lint>
+
+=item
+
+ALEPHSEQ: L<Catmandu::Importer::MARC::ALEPHSEQ>
 
 =back
 
+    E.g.
+
+    catmandu convert MARC --type XML to MARC --type ISO < marc.xml > marc.iso
+
 =head1 SEE ALSO
 
 L<Catmandu::Exporter::MARC>
-
-=cut

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



More information about the Pkg-perl-cvs-commits mailing list