summaryrefslogtreecommitdiff
path: root/av.c
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2013-01-12 08:48:01 -0700
committerKarl Williamson <public@khwilliamson.com>2013-01-12 09:00:07 -0700
commitf5d13a25262cb242090ad5e0703cf287e26156db (patch)
treead31ce7498edc127c1dcf42db4a3ed9c2940422f /av.c
parent6d5d702a337e9161f8eb85180a83c4469a8f7ed7 (diff)
downloadperl-f5d13a25262cb242090ad5e0703cf287e26156db.tar.gz
perlapi: Clarify av_pop
This notes that the caller now has control of a reference count of the returned SV. Wording mostly suggested by Paul Evans
Diffstat (limited to 'av.c')
-rw-r--r--av.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/av.c b/av.c
index b251822dde..475496d534 100644
--- a/av.c
+++ b/av.c
@@ -592,8 +592,9 @@ Perl_av_push(pTHX_ AV *av, SV *val)
/*
=for apidoc av_pop
-Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
-is empty.
+Removes one SV from the end 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<pop(@myarray);>