replace misleading docs with a BUGS section

p4raw-id: //depot/perl@4960

1 files changed, 6 insertions, 8 deletions

diff --git a/lib/English.pm b/lib/English.pm
index 9ed4fc8597..86d75a4268 100644
--- a/lib/English.pm
+++ b/lib/English.pm
@@ -15,14 +15,6 @@ English - use nice English (or awk) names for ugly punctuation variables
 
 =head1 DESCRIPTION
 
-You should I<not> use this module in programs intended to be portable
-among Perl versions, programs that must perform regular expression
-matching operations efficiently, or libraries intended for use with
-such programs.  In a sense, this module is deprecated.  The reasons
-for this have to do with implementation details of the Perl
-interpreter which are too thorny to go into here.  Perhaps someday
-they will be fixed to make "C<use English>" more practical.
-
 This module provides aliases for the built-in variables whose
 names no one seems to like to read.  Variables with side-effects
 which get triggered just by accessing them (like $0) will still 
@@ -35,6 +27,12 @@ $INPUT_RECORD_SEPARATOR if you are using the English module.
 
 See L<perlvar> for a complete list of these.
 
+=head1 BUGS
+
+This module provokes sizeable inefficiencies for regular expressions,
+due to unfortunate implementation details.  If performance matters,
+consider avoiding English.
+
 =cut
 
 no warnings;