More caveat tweaks

[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 7080b66..29c17e5 100644 (file)
--- a/lib/MooseX/Role/Parameterized.pm
+++ b/lib/MooseX/Role/Parameterized.pm
@@ -1,8 +1,10 @@
-#!/usr/bin/env perl
 package MooseX::Role::Parameterized;
+
+# ABSTRACT: parameterized roles
+
 use Moose (
     extends => { -as => 'moose_extends' },
-    around => { -as => 'moose_around' },
+    around  => { -as => 'moose_around' },
     qw/confess blessed/,
 );
 
@@ -16,7 +18,11 @@ our $CURRENT_METACLASS;
 
 __PACKAGE__->setup_import_methods(
     with_caller => ['parameter', 'role', 'method'],
-    as_is       => ['has', 'with', 'extends', 'requires', 'excludes', 'augment', 'inner', 'before', 'after', 'around', 'super', 'override', 'confess', 'blessed'],
+    as_is       => [
+        'has', 'with', 'extends', 'requires', 'excludes', 'augment', 'inner',
+        'before', 'after', 'around', 'super', 'override', 'confess',
+        'blessed',
+    ],
 );
 
 sub parameter {
@@ -174,10 +180,6 @@ sub augment { croak "Roles cannot support 'augment'" }
 
 __END__
 
-=head1 NAME
-
-MooseX::Role::Parameterized - parameterized roles, at long last
-
 =head1 SYNOPSIS
 
     package MyRole::Counter;
@@ -248,9 +250,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