This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Clarify the isFOO_A() macros meanings
authorKarl Williamson <khw@cpan.org>
Mon, 12 Dec 2016 03:30:33 +0000 (20:30 -0700)
committerKarl Williamson <khw@cpan.org>
Wed, 14 Dec 2016 17:52:48 +0000 (10:52 -0700)
handy.h

diff --git a/handy.h b/handy.h
index 5e31d1e..1eb8892 100644 (file)
--- a/handy.h
+++ b/handy.h
@@ -549,7 +549,8 @@ ASCII character in the named class based on platform, Unicode, and Perl rules.
 If the input is a number that doesn't fit in an octet, FALSE is returned.
 
 Variant C<isFOO_A> (e.g., C<isALPHA_A()>) is identical to the base function
-with no suffix C<"_A">.
+with no suffix C<"_A">.  This variant is used to emphasize by its name that
+only ASCII-range characters can return TRUE.
 
 Variant C<isFOO_L1> imposes the Latin-1 (or EBCDIC equivlalent) character set
 onto the platform.  That is, the code points that are ASCII are unaffected,