doc fixes; 0.01 release

[gitmo/MooseX-Runnable.git] / lib / MooseX / Runnable / Invocation / Scheme / MooseX / Getopt.pm

diff --git a/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm b/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
index e286151..7bd6b72 100644 (file)
--- a/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
+++ b/lib/MooseX/Runnable/Invocation/Scheme/MooseX/Getopt.pm
@@ -16,4 +16,27 @@ around create_instance => sub {
     return ($instance, @$more_args);
 };
 
+# XXX: arounds that don't actually call $orig fuck up plugins.  i
+# think that's OK, mostly, but it's something to keep in mind...
+
 1;
+
+__END__
+
+=head1 NAME
+
+MooseX::Runnable::Invocation::Scheme::MooseX::Getopt - run MX::Getopt classes
+
+=head1 DESCRIPTION
+
+This role will be used by C<MooseX::Runnable::Invocation> to create an
+instance of the class to be run with C<MooseX::Getopt>.  Any args not
+consumed by MX::Getopt will be passed to the class's run method.
+
+(See the test C<t/basic-mx-getopt.t> for an example.)
+
+=head1 SEE ALSO
+
+L<MooseX::Runnable>
+
+L<MooseX::Getopt>