summaryrefslogtreecommitdiff
path: root/av.c
diff options
context:
space:
mode:
authorClaes Jacobsson <claes@surfar.nu>2008-08-09 13:22:18 +0200
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>2008-09-07 21:38:23 +0000
commit6ae70e43e2b6c91e0b17a0d0230d31e20fe21a70 (patch)
treea411ccdca1c506c2cf9c9338fd3f305f38776356 /av.c
parentedbe35ea95baf286c38bf4d7db7d18b82ecce254 (diff)
downloadperl-6ae70e43e2b6c91e0b17a0d0230d31e20fe21a70.tar.gz
[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
Diffstat (limited to 'av.c')
-rw-r--r--av.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/av.c b/av.c
index 67ffad9f42..3d15d58f85 100644
--- 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
*/