summaryrefslogtreecommitdiff
path: root/av.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2016-03-07 15:45:35 -0700
committerKarl Williamson <khw@cpan.org>2016-03-07 16:56:17 -0700
commitb895c103935275c98071d016c904adec2efa6611 (patch)
treeea71a6468f1d3afcb4d93369be4645f9b2ca5048 /av.c
parent7febee86752168a2e917e81a2ed763926dd31933 (diff)
downloadperl-b895c103935275c98071d016c904adec2efa6611.tar.gz
perlapi: Slight clarification
This changes to use 'transfer' to make clear that the reference count is unchanged. Some think that the previous wording 'take' is good as-is; some agree with me. Daniel Dragan has pointed out that 5 years ago I changed this line, while retaining 'take'. Given that 'transfer' is unambiguous to all, while 'take' is ambiguous to some, I'm making the change.
Diffstat (limited to 'av.c')
-rw-r--r--av.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/av.c b/av.c
index 9a5644a0e2..fc2004ee43 100644
--- a/av.c
+++ b/av.c
@@ -567,8 +567,8 @@ Perl_av_create_and_push(pTHX_ AV **const avp, SV *const val)
/*
=for apidoc av_push
-Pushes an SV onto the end of the array. The array will grow automatically
-to accommodate the addition. This takes ownership of one reference count.
+Pushes an SV (transferring control of one reference count) onto the end of the
+array. The array will grow automatically to accommodate the addition.
Perl equivalent: C<push @myarray, $elem;>.