summaryrefslogtreecommitdiff
path: root/av.c
diff options
context:
space:
mode:
authorSteffen Mueller <smueller@cpan.org>2013-07-20 17:53:08 +0200
committerSteffen Mueller <smueller@cpan.org>2013-07-20 17:53:08 +0200
commitdbc2ea0c923176b1040e2ba2a21bd680cce3be11 (patch)
treef94c9a8a5e85d1dc540b3f17a88a34a43afbba4e /av.c
parentbe456e362b6aa97144209dad66d321b296b7e2c8 (diff)
downloadperl-dbc2ea0c923176b1040e2ba2a21bd680cce3be11.tar.gz
Clarify av_shift API docs
Diffstat (limited to 'av.c')
-rw-r--r--av.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/av.c b/av.c
index fb01f48a09..b15f6ff7b6 100644
--- a/av.c
+++ b/av.c
@@ -697,9 +697,9 @@ Perl_av_unshift(pTHX_ AV *av, I32 num)
/*
=for apidoc av_shift
-Shifts an SV off the beginning of the
-array. Returns C<&PL_sv_undef> if the
-array is empty.
+Removes one SV from the start of the array, reducing its size by one and
+returning the SV (transferring control of one reference count) to the
+caller. Returns C<&PL_sv_undef> if the array is empty.
Perl equivalent: C<shift(@myarray);>