Add Completion docs re filename expansion default

[p5sagit/Devel-REPL.git] / lib / Devel / REPL / Plugin / Completion.pm

diff --git a/lib/Devel/REPL/Plugin/Completion.pm b/lib/Devel/REPL/Plugin/Completion.pm
index 1e2b09a..b1b4e99 100644 (file)
--- a/lib/Devel/REPL/Plugin/Completion.pm
+++ b/lib/Devel/REPL/Plugin/Completion.pm
@@ -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> >>