Make SvOK and SvTRUE API docs slightly less utterly confusing
authorSteffen Mueller <smueller@cpan.org>
Sat, 13 Jun 2009 10:20:31 +0000 (12:20 +0200)
committerSteffen Mueller <smueller@cpan.org>
Sat, 13 Jun 2009 10:20:31 +0000 (12:20 +0200)
sv.h

diff --git a/sv.h b/sv.h
index a1e990a..243b798 100644 (file)
--- a/sv.h
+++ b/sv.h
@@ -599,8 +599,8 @@ double.  Checks the B<private> setting.  Use C<SvNIOK> instead.
 Unsets the NV/IV status of an SV.
 
 =for apidoc Am|U32|SvOK|SV* sv
-Returns a U32 value indicating whether the value is an SV. It also tells
-whether the value is defined or not.
+Returns a U32 value indicating whether the value is defined. This is
+only meaningful for scalars.
 
 =for apidoc Am|U32|SvIOKp|SV* sv
 Returns a U32 value indicating whether the SV contains an integer.  Checks
@@ -1465,7 +1465,7 @@ otherwise use the more efficient C<SvUV>.
 
 =for apidoc Am|bool|SvTRUE|SV* sv
 Returns a boolean indicating whether Perl would evaluate the SV as true or
-false, defined or undefined.  Does not handle 'get' magic.
+false.  See SvOK() for a defined/undefined test.  Does not handle 'get' magic.
 
 =for apidoc Am|char*|SvPVutf8_force|SV* sv|STRLEN len
 Like C<SvPV_force>, but converts sv to utf8 first if necessary.