This is a live mirror of the Perl 5 development currently hosted at
https://github.com/perl/perl5
https://perl5.git.perl.org
/
perl5.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
be456e3
)
Clarify av_shift API docs
author
Steffen Mueller
<smueller@cpan.org>
Sat, 20 Jul 2013 15:53:08 +0000
(17:53 +0200)
committer
Steffen Mueller
<smueller@cpan.org>
Sat, 20 Jul 2013 15:53:08 +0000
(17:53 +0200)
av.c
patch
|
blob
|
blame
|
history
diff --git
a/av.c
b/av.c
index
fb01f48
..
b15f6ff
100644
(file)
--- 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);>