From ac8b87d7b0cd3f06bbb75d2642abb5f6f9dea5a2 Mon Sep 17 00:00:00 2001 From: Eric Brine Date: Mon, 3 Jun 2013 10:26:11 -0700 Subject: Fix internal inconsistencies in style in utf8.pm docs --- lib/utf8.pm | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'lib/utf8.pm') diff --git a/lib/utf8.pm b/lib/utf8.pm index 68f65dec25..666807be18 100644 --- a/lib/utf8.pm +++ b/lib/utf8.pm @@ -42,8 +42,8 @@ utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code utf8::encode($string); # "\x{100}" becomes "\xc4\x80" utf8::decode($string); # "\xc4\x80" becomes "\x{100}" - $flag = utf8::is_utf8(STRING); # since Perl 5.8.1 - $flag = utf8::valid(STRING); + $flag = utf8::is_utf8($string); # since Perl 5.8.1 + $flag = utf8::valid($string); =head1 DESCRIPTION @@ -126,7 +126,7 @@ that the substr() or length() function works with the usually faster byte algorithm. Fails if the original I sequence cannot be represented in the -native 8 bit encoding. On failure dies or, if the value of C<$fail_ok> is +native 8 bit encoding. On failure dies or, if the value of I<$fail_ok> is true, returns false. Returns true on success. @@ -169,16 +169,16 @@ B Therefore Encode is recommended for the general purposes; see also L. -=item * $flag = utf8::is_utf8(STRING) +=item * $flag = utf8::is_utf8($string) -(Since Perl 5.8.1) Test whether STRING is marked internally as encoded in +(Since Perl 5.8.1) Test whether I<$string> is marked internally as encoded in UTF-8. Functionally the same as Encode::is_utf8(). -=item * $flag = utf8::valid(STRING) +=item * $flag = utf8::valid($string) -[INTERNAL] Test whether STRING is in a consistent state regarding +[INTERNAL] Test whether I<$string> is in a consistent state regarding UTF-8. Will return true if it is well-formed UTF-8 and has the UTF-8 flag -on B if STRING is held as bytes (both these states are 'consistent'). +on B if I<$string> is held as bytes (both these states are 'consistent'). Main reason for this routine is to allow Perl's test suite to check that operations have left strings in a consistent state. You most probably want to use utf8::is_utf8() instead. -- cgit v1.2.1