Revamp t/92-pod-coverage.t

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

diff --git a/lib/App/Rgit/Policy/Interactive.pm b/lib/App/Rgit/Policy/Interactive.pm
index f6f20b501d5199059a77f1d1f15f9ec6da2669fc..fd4d9df8609aab26d41d24dc84e5a97cb8696451 100644 (file)
--- a/lib/App/Rgit/Policy/Interactive.pm
+++ b/lib/App/Rgit/Policy/Interactive.pm
@@ -21,6 +21,23 @@ Version 0.06
 
 our $VERSION = '0.06';
 
+=head1 DESCRIPTION
+
+When a run exited with non-zero status, this policy asks the user whether he wants to ignore and continue with the next repository, ignore all future possible errors, retry this run or open a shell in the current repository.
+In this last case, the user will be asked again what to do when he will close the shell.
+
+=head1 METHODS
+
+This class inherits from L<App::Rgit::Policy>.
+
+It implements :
+
+=head2 C<new>
+
+The constructor will die if L<Term::ReadKey> can't be loaded.
+
+=cut
+
 my ($int_code, $shell);
 
 sub new {
@@ -46,6 +63,10 @@ sub new {
  $class->SUPER::new(@_);
 }
 
+=head2 C<handle>
+
+=cut
+
 my %codes = (
  'a' => [ LAST,        'aborting' ],
  'i' => [ NEXT,        'ignoring' ],
@@ -53,7 +74,7 @@ my %codes = (
  'r' => [ REDO,        'retrying' ],
 );
 
-sub report {
+sub handle {
  my ($policy, $cmd, $conf, $repo, $status, $signal) = @_;
 
  return NEXT unless $status;
@@ -94,6 +115,10 @@ sub report {
 
 L<rgit>.
 
+L<App::Rgit::Policy>.
+
+L<Term::ReadKey>.
+
 =head1 AUTHOR
 
 Vincent Pit, C<< <perl at profvince.com> >>, L<http://profvince.com>.