summaryrefslogtreecommitdiffstats
path: root/lib/Reply
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2013-06-12 21:22:42 -0500
committerJesse Luehrs <doy@tozt.net>2013-06-12 21:22:42 -0500
commit40680f3e638f83b5ae2f5713d94b753917ab85a4 (patch)
tree291e8cfcd291b7cbfc47a9478a6fe7a1991fa905 /lib/Reply
parent8f98724222889ab7bfdc90584fb987a94f3ba1ac (diff)
downloadcarp-reply-40680f3e638f83b5ae2f5713d94b753917ab85a4.tar.gz
carp-reply-40680f3e638f83b5ae2f5713d94b753917ab85a4.zip
docs
Diffstat (limited to 'lib/Reply')
-rw-r--r--lib/Reply/Plugin/CarpReply.pm16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/Reply/Plugin/CarpReply.pm b/lib/Reply/Plugin/CarpReply.pm
index e4f5330..219121f 100644
--- a/lib/Reply/Plugin/CarpReply.pm
+++ b/lib/Reply/Plugin/CarpReply.pm
@@ -6,6 +6,22 @@ use base 'Reply::Plugin';
use Devel::StackTrace::WithLexicals;
+=head1 SYNOPSIS
+
+ Reply->new(plugins => ['CarpReply'])->run;
+
+=head1 DESCRIPTION
+
+This plugin implements the L<Reply> shell commands to support L<Carp::Reply>'s
+behavior. It currently isn't incredibly useful on its own as part of a config
+file, but can be useful if you want more control over creating a
+Carp::Reply-like shell.
+
+See the L<Carp::Reply> docs for a description of the commands provided by this
+plugin.
+
+=cut
+
sub new {
my $class = shift;