From: Tara L Andrews <tla@mit.edu>
Date: Mon, 3 Oct 2011 17:19:24 +0000 (+0200)
Subject: fix perldoc
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=25331c4994b1ab7b9e4a90c8cc7ef9563a7ecbc4;p=scpubgit%2Fstemmatology.git

fix perldoc
---

diff --git a/lib/Text/Tradition/Parser/Util.pm b/lib/Text/Tradition/Parser/Util.pm
index 6d9dab1..a1fe4b2 100644
--- a/lib/Text/Tradition/Parser/Util.pm
+++ b/lib/Text/Tradition/Parser/Util.pm
@@ -7,9 +7,18 @@ use Exporter 'import';
 use vars qw/ @EXPORT_OK /;
 @EXPORT_OK = qw/ add_hash_entry check_for_repeated cmp_str collate_variants is_monotonic /;
 
-=item B<collate_variants>
+=head1 NAME
 
-collate_variants( $collation, @reading_ranges )
+Text::Tradition::Parser::Util
+
+=head1 DESCRIPTION
+
+A collection of utilities used by multiple Text::Tradition parsers.  
+Probably not of external interest.
+
+=head1 METHODS
+
+=head2 B<collate_variants>( $collation, @reading_ranges )
 
 Given a set of readings in the form 
 ( lemma_start, lemma_end, rdg1_start, rdg1_end, ... )
@@ -124,12 +133,6 @@ sub _collation_hash {
     return cmp_str( $node );
 }
 
-=item B<cmp_str>
-
-Pretend you never saw this method.  Really it needs to not be hardcoded.
-
-=cut
-
 sub cmp_str {
     my( $reading ) = @_;
     my $word = $reading->label();
@@ -143,9 +146,7 @@ sub cmp_str {
     return $word;
 }
 
-=item B<collate_variants>
-
-my @rep = check_for_repeated( @readings )
+=head2 B<check_for_repeated>( @readings )
 
 Given an array of items, returns any items that appear in the array more
 than once.
@@ -191,4 +192,24 @@ sub is_monotonic {
         $max = $rdg->position->max;
     }
     return 1;
-}
\ No newline at end of file
+}
+
+1;
+
+=head1 BUGS / TODO
+
+=over
+
+=item * Get rid of abomination that is cmp_str.
+
+=back
+
+=head1 LICENSE
+
+This package is free software and is provided "as is" without express
+or implied warranty.  You can redistribute it and/or modify it under
+the same terms as Perl itself.
+
+=head1 AUTHOR
+
+Tara L Andrews E<lt>aurum@cpan.orgE<gt>