perlapi: Slight clarification
authorKarl Williamson <khw@cpan.org>
Mon, 7 Mar 2016 22:45:35 +0000 (15:45 -0700)
committerKarl Williamson <khw@cpan.org>
Mon, 7 Mar 2016 23:56:17 +0000 (16:56 -0700)
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.

av.c

diff --git a/av.c b/av.c
index 9a5644a..fc2004e 100644 (file)
--- 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;>.