Add Completion docs re filename expansion default
Chris Marshall [Sun, 13 Jun 2010 18:21:34 +0000 (14:21 -0400)]
Since the fact that the Completion plugin *disables* an already
on feature, added a note to that effect.  The current behavior
is: no Completion plugin loaded then you'll get the Term::ReadLine
default of filename expansion (unless disabled at the Term::ReadLine
level), and with Completion plugin loaded any fallback Term::ReadLine
expansion will not happen.  To use Term::ReadLine completion again,
just set the do_readline_filename_completion attribute to 1.

lib/Devel/REPL/Plugin/Completion.pm

index 1e2b09a..b1b4e99 100644 (file)
@@ -126,6 +126,13 @@ __END__
 
 Devel::REPL::Plugin::Completion - Extensible tab completion
 
+=head1 NOTE
+
+By default, the Completion plugin explicitly does I<not> use the Gnu readline
+or Term::ReadLine::Perl fallback filename completion.
+
+Set the attribute C<do_readline_filename_completion> to 1 to enable this feature.
+
 =head1 AUTHOR
 
 Shawn M Moore, C<< <sartak at gmail dot com> >>