Document App::Rgit::Command::report

[perl/modules/rgit.git] / lib / App / Rgit / Command.pm

diff --git a/lib/App/Rgit/Command.pm b/lib/App/Rgit/Command.pm
index 6361d083cc0e56fd16c86bd3a9be6a4e82e543f2..d2d837346f29192ed970a80af41cc60ea60ef950 100644 (file)
--- a/lib/App/Rgit/Command.pm
+++ b/lib/App/Rgit/Command.pm
@@ -15,11 +15,11 @@ App::Rgit::Command - Base class for App::Rgit commands.
 
 =head1 VERSION
 
-Version 0.04
+Version 0.05
 
 =cut
 
-our $VERSION = '0.04';
+our $VERSION = '0.05';
 
 =head1 DESCRIPTION
 
@@ -80,6 +80,9 @@ sub action {
 
 =head2 C<report $conf, $repo, $status>
 
+Reports that the execution of the command in C<$repo> exited with C<status> to the current command's policy.
+Returns what the policy callback returned, which should be one of the policy codes listed in C<App::Rgit::Utils>.
+
 =cut
 
 sub report {