mktables: White-space only

[perl5.git] / lib / utf8.pm

diff --git a/lib/utf8.pm b/lib/utf8.pm
index 49dd690..43c7277 100644 (file)
--- a/lib/utf8.pm
+++ b/lib/utf8.pm
@@ -2,7 +2,7 @@ package utf8;
 
 $utf8::hint_bits = 0x00800000;
 
-our $VERSION = '1.12';
+our $VERSION = '1.13';
 
 sub import {
     $^H |= $utf8::hint_bits;
@@ -34,7 +34,7 @@ utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code
  # Convert the internal representation of a Perl scalar to/from UTF-8.
 
  $num_octets = utf8::upgrade($string);
- $success    = utf8::downgrade($string[, FAIL_OK]);
+ $success    = utf8::downgrade($string[, $fail_ok]);
 
  # Change each character of a Perl scalar to/from a series of
  # characters that represent the UTF-8 bytes of each original character.
@@ -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
 
@@ -95,7 +95,7 @@ C<no utf8;>.
 
 The following functions are defined in the C<utf8::> package by the
 Perl core.  You do not need to say C<use utf8> to use these and in fact
-you should not say that  unless you really want to have UTF-8 source code.
+you should not say that unless you really want to have UTF-8 source code.
 
 =over 4
 
@@ -114,7 +114,7 @@ B<Note that this function does not handle arbitrary encodings.>
 Therefore Encode is recommended for the general purposes; see also
 L<Encode>.
 
-=item * $success = utf8::downgrade($string[, FAIL_OK])
+=item * $success = utf8::downgrade($string[, $fail_ok])
 
 Converts in-place the internal representation of the string from
 I<UTF-X> to the equivalent octet sequence in the native encoding (Latin-1
@@ -126,7 +126,7 @@ that the substr() or length() function works with the usually faster
 byte algorithm.
 
 Fails if the original I<UTF-X> 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.
@@ -153,7 +153,7 @@ L<Encode>.
 
 =item * $success = utf8::decode($string)
 
-Attempts to convert in-place the octet sequence in I<UTF-X> to the
+Attempts to convert in-place the octet sequence encoded as I<UTF-X> to the
 corresponding character sequence. That is, it replaces each sequence of
 characters in the string whose ords represent a valid UTF-X byte
 sequence, with the corresponding single character.  The UTF-8 flag is
@@ -169,16 +169,16 @@ B<Note that this function does not handle arbitrary encodings.>
 Therefore Encode is recommended for the general purposes; see also
 L<Encode>.
 
-=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<or> if STRING is held as bytes (both these states are 'consistent').
+on B<or> 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.