Dist tweaks; this commit is 0.01

[gitmo/MooseX-Role-Parameterized.git] / lib / MooseX / Role / Parameterized.pm

diff --git a/lib/MooseX/Role/Parameterized.pm b/lib/MooseX/Role/Parameterized.pm
index e39aeb6..47377c1 100644 (file)
--- a/lib/MooseX/Role/Parameterized.pm
+++ b/lib/MooseX/Role/Parameterized.pm
@@ -1,7 +1,5 @@
 package MooseX::Role::Parameterized;
 
-# ABSTRACT: parameterized roles, at long last
-
 use Moose (
     extends => { -as => 'moose_extends' },
     around  => { -as => 'moose_around' },
@@ -180,6 +178,10 @@ sub augment { croak "Roles cannot support 'augment'" }
 
 __END__
 
+=head1 NAME
+
+MooseX::Role::Parameterized - parameterized roles
+
 =head1 SYNOPSIS
 
     package MyRole::Counter;
@@ -241,8 +243,8 @@ customizable!
 
 There are many paths to parameterized roles (hopefully with a consistent enough
 API); I believe this to be the easiest and most flexible implementation.
-Coincidentally, Pugs has a very similar design (I'm not convinced that that is
-a good thing yet).
+Coincidentally, Pugs has a very similar design (I'm not yet convinced that that
+is a good thing).
 
 =head1 CAVEATS
 
@@ -250,9 +252,16 @@ You must use this syntax to declare methods in the role block:
 C<method NAME => sub { ... };>. This is due to a limitation in Perl. In return
 though you can use parameters I<in your methods>!
 
-L<Moose::Role/alias> and L<Moose::Role/excludes> are not yet supported. Because
-I'm totally unsure of whether they should be handled by this module, both
-declaring and providing a parameter named C<alias> or C<excludes> is an error.
+You must use all the keywords in the role block. If it turns out to be correct,
+we'll compose the parameterizable role (everything outside the role block) with
+the parameterized role (everything inside the role block). We throw an error if
+you try to use a keyword outside of the role block, so don't worry about it for
+now.
+
+L<Moose::Role/alias> and L<Moose::Role/excludes> are not yet supported. I'm
+completely unsure of whether they should be handled by this module. Until we
+figure out a plan, both declaring and providing a parameter named C<alias> or
+C<excludes> is an error.
 
 =head1 AUTHOR