Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Improve the Plugin::Pod* documentation #116

Closed
wants to merge 1 commit into from

2 participants

@shlomif

Per our discussion on IRC: add synopses, and references to "dzil test --release".

@shlomif shlomif Improve the Plugin::Pod* documentation.
Add synopses, and references to "dzil test --release".
5d9f5c7
@rjbs
Owner

As we discussed on IRC, these documentation changes just serve to document the basics of dzil in each affected plugin, which is a trend I do not want to start.

@rjbs rjbs closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 13, 2012
  1. @shlomif

    Improve the Plugin::Pod* documentation.

    shlomif authored
    Add synopses, and references to "dzil test --release".
This page is out of date. Refresh to see the latest.
View
10 lib/Dist/Zilla/Plugin/PodCoverageTests.pm
@@ -5,6 +5,14 @@ extends 'Dist::Zilla::Plugin::InlineFiles';
use namespace::autoclean;
+=head1 SYNOPSIS
+
+ # Add this line to dist.ini
+ [PodCoverageTests]
+
+ # Run this in the command line to test for POD coverage:
+ $ dzil test --release
+
=head1 DESCRIPTION
This is an extension of L<Dist::Zilla::Plugin::InlineFiles>, providing the
@@ -18,6 +26,8 @@ documentation can be found, you can add:
=for Pod::Coverage sub_name other_sub this_one_too
+One can run the release tests by invoking C<dzil test --release>.
+
=cut
__PACKAGE__->meta->make_immutable;
View
10 lib/Dist/Zilla/Plugin/PodSyntaxTests.pm
@@ -5,6 +5,14 @@ extends 'Dist::Zilla::Plugin::InlineFiles';
use namespace::autoclean;
+=head1 SYNTAX
+
+ # Add this to your dist.ini.
+ [PodSyntaxTests]
+
+ # To test for POD validity, run this in the shell:
+ $ dzil test --release
+
=head1 DESCRIPTION
This is an extension of L<Dist::Zilla::Plugin::InlineFiles>, providing the
@@ -12,6 +20,8 @@ following files:
xt/release/pod-syntax.t - a standard Test::Pod test
+One can run the release tests by invoking C<dzil test --release>.
+
=cut
__PACKAGE__->meta->make_immutable;
Something went wrong with that request. Please try again.