[DOC PATCH] av.c - clearify that av_shift returns &PL_sv_undef if array is empty

Message-Id: <0726E7A8-C29F-409C-81E6-B464EE6A3DDD@surfar.nu>

p4raw-id: //depot/perl@34311

diff --git a/av.c b/av.c
index 67ffad9..3d15d58 100644 (file)
--- a/av.c
+++ b/av.c
@@ -701,7 +701,8 @@ Perl_av_unshift(pTHX_ register AV *av, register I32 num)
 /*
 =for apidoc av_shift
 
-Shifts an SV off the beginning of the array.
+Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the 
+array is empty.
 
 =cut
 */