From 6c4b97722ea6f8158e43b49bb8133e7385e1c0cc Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Sat, 8 Jun 2013 14:40:06 -0500 Subject: doc updates --- lib/Reply.pm | 11 ++++++++++- lib/Reply/Plugin.pm | 5 +++-- 2 files changed, 13 insertions(+), 3 deletions(-) (limited to 'lib') diff --git a/lib/Reply.pm b/lib/Reply.pm index 6f7adb2..4826b25 100644 --- a/lib/Reply.pm +++ b/lib/Reply.pm @@ -102,7 +102,7 @@ sub new { =method run Runs the repl. Will continue looping until the C callback returns -undef. +undef or the C callback returns false. =cut @@ -113,6 +113,15 @@ sub run { print "\n"; } +=method run_one($line) + +Runs a single iteration of the repl. If C<$line> is given, it will be used as +the string to evaluate (and the C and C callbacks will not +be called). Returns true if the repl can continue, and false if it was +requested to quit. + +=cut + sub run_one { my $self = shift; my ($line) = @_; diff --git a/lib/Reply/Plugin.pm b/lib/Reply/Plugin.pm index 0e8fe45..5442a4f 100644 --- a/lib/Reply/Plugin.pm +++ b/lib/Reply/Plugin.pm @@ -112,8 +112,9 @@ implementation just uses C to print them to the screen. =item loop (chained) -This callback is called at the end of each evaluation. It receives no -parameters and returns nothing. +This callback is called at the end of each evaluation. It receives whether the +repl has been requested to terminate so far, and returns whether the repl +should terminate. =back -- cgit v1.2.3-54-g00ecf