This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: Minor clarifications to sv_utf8_decode
authorKarl Williamson <khw@cpan.org>
Thu, 15 Sep 2016 15:06:39 +0000 (09:06 -0600)
committerKarl Williamson <khw@cpan.org>
Mon, 26 Sep 2016 04:24:19 +0000 (22:24 -0600)
sv.c

diff --git a/sv.c b/sv.c
index 3cf52d9..850c727 100644 (file)
--- a/sv.c
+++ b/sv.c
@@ -3749,11 +3749,11 @@ Perl_sv_utf8_encode(pTHX_ SV *const sv)
 /*
 =for apidoc sv_utf8_decode
 
-If the PV of the SV is an octet sequence in UTF-8
+If the PV of the SV is an octet sequence in Perl's extended UTF-8
 and contains a multiple-byte character, the C<SvUTF8> flag is turned on
 so that it looks like a character.  If the PV contains only single-byte
 characters, the C<SvUTF8> flag stays off.
-Scans PV for validity and returns false if the PV is invalid UTF-8.
+Scans PV for validity and returns FALSE if the PV is invalid UTF-8.
 
 =cut
 */