summaryrefslogtreecommitdiff
path: root/lib/English.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/English.pm')
-rw-r--r--lib/English.pm8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/English.pm b/lib/English.pm
index bbb6bd7b28..7aa0d84617 100644
--- a/lib/English.pm
+++ b/lib/English.pm
@@ -15,6 +15,14 @@ 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