Commits

Shlomi Fish committed 9b424ac

More documentation.

Comments (0)

Files changed (3)

MediaWiki-CleanupHTML/Build.PL

-use 5.006;
+use 5.008;
 use strict;
 use warnings;
 use Module::Build;

MediaWiki-CleanupHTML/MANIFEST

 t/manifest.t
 t/pod-coverage.t
 t/pod.t
+Makefile.PL
+META.yml
+META.json

MediaWiki-CleanupHTML/lib/MediaWiki/CleanupHTML.pm

 
 =head1 SYNOPSIS
 
-Quick summary of what the module does.
-
-Perhaps a little code snippet.
-
     use MediaWiki::CleanupHTML;
 
     open my $fh, '<:encoding(UTF-8)', $filename
 
     $cleaner->destroy_resources();
 
+=head1 DESCRIPTION
+
+The HTML rendered on MediaWiki pages is full of MediaWiki-specific 
+embellishments such as edit sections. This module attempts to clean it up
+and return a more straightforward HTML. Note that the HTML returned by
+MediaWiki APIs may not always available (for instance if the wiki is down), so
+this module should be considered a fallback.
+
 =head1 SUBROUTINES/METHODS
 
 =head2 MediaWiki::CleanupHTML->new({fh => $fh})
 the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MediaWiki-CleanupHTML>.  I will be notified, and then you'll
 automatically be notified of progress on your bug as I make changes.
 
-
-
-
 =head1 SUPPORT
 
 You can find documentation for this module with the perldoc command.
 
 =back
 
-
 =head1 ACKNOWLEDGEMENTS
 
+The developers of L<HTML::TreeBuilder::XPath>, L<HTML::TreeBuilder> and related
+modules for their helpful code.
 
 =head1 LICENSE AND COPYRIGHT