| CC: | Caleb Cushing <xenoterracide [...] gmail.com> |
| Subject: | [PATCH] fix documentation |
| Date: | Wed, 28 Jul 2010 06:46:36 -0400 |
| To: | bugs-dist-zilla [...] rt.cpan.org |
| From: | Caleb Cushing <xenoterracide [...] gmail.com> |
add a SYNOPSIS and correct what the documentation says is inserted to be
accurate.
Signed-off-by: Caleb Cushing <xenoterracide@gmail.com>
---
explanation for how to apply this patch can be found here
http://www.xenoterracide.com/2010/06/rt-git-workflow.html
lib/Dist/Zilla/Plugin/PkgVersion.pm | 14 ++++++++++++--
1 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/lib/Dist/Zilla/Plugin/PkgVersion.pm b/lib/Dist/Zilla/Plugin/PkgVersion.pm
index 9ef02c0..d015d33 100644
--- a/lib/Dist/Zilla/Plugin/PkgVersion.pm
+++ b/lib/Dist/Zilla/Plugin/PkgVersion.pm
@@ -9,13 +9,23 @@ with(
);
use PPI;
+=head1 SYNOPSIS
+
+in dist.ini
+
+ [PkgVersion]
=head1 DESCRIPTION
-This plugin will add a line like the following to each package in each Perl
+This plugin will add a lines like the following to each package in each Perl
module or program (more or less) within the distribution:
- our $VERSION = 0.001; # where 0.001 is the version of the dist
+ BEGIN {
+ $MyModule::VERSION = 0.001;
+ }
+
+note: where 0.001 is the version of the dist, and $MyModule is the name of
+your modules
It will skip any package declaration that includes a newline between the
C<package> keyword and the package name, like:
--
1.7.2