From: Chris Marshall <devel.chm.01@gmail.com>
Date: Sat, 12 Jun 2010 18:46:51 +0000 (-0400)
Subject: Add a bit more description of Turtle plugin.
X-Git-Tag: v1.003015~28
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=79e70b9ce0a3066a8ad8950e9cb32f6198afd592;p=p5sagit%2FDevel-REPL.git

Add a bit more description of Turtle plugin.

This description of what the Turtle plugin is looking for and
the default_command_prefix character value of '#' now makes it
clear that other uses of '#' may conflict with this plugin.
This is relevant to PDL shell development which uses '#' as the
shell escape character which conflicts with Turtle usages.
---

diff --git a/lib/Devel/REPL/Plugin/Turtles.pm b/lib/Devel/REPL/Plugin/Turtles.pm
index b53a3c1..0ae8299 100644
--- a/lib/Devel/REPL/Plugin/Turtles.pm
+++ b/lib/Devel/REPL/Plugin/Turtles.pm
@@ -75,5 +75,19 @@ __END__
 
 Devel::REPL::Plugin::Turtles - Generic command creation using a read hook
 
+=head1 DESCRIPTION
+
+By default, this plugin allows calling commands using a read hook
+to detect a default_command_prefix followed by the command name,
+say MYCMD as an example.  The actual routine to call for the
+command is constructed by looking for subs named 'command_MYCMD'
+or 'expr_MYCMD' and executing them.
+
+=head2 NOTE
+
+The C<default_command_prefix> is C<qr/\#/> so care must be taken
+if other uses for that character are needed (e.g., '#' for the
+shell escape character in the PDL shell.
+
 =cut