diff options
author | Chip Salzenberg <chip@pobox.com> | 2010-10-14 17:50:10 -0700 |
---|---|---|
committer | Chip Salzenberg <chip@pobox.com> | 2010-10-14 17:50:10 -0700 |
commit | 3025a2e42cd703f48878ec60605f8960d5732efb (patch) | |
tree | ffcdfcd804cae539ba252a63e49449b2eb132c1e /av.c | |
parent | 582bd8796b98142a11f99996b4e934a363b2cac0 (diff) | |
download | perl-3025a2e42cd703f48878ec60605f8960d5732efb.tar.gz |
Document that av_delete and hv_delete make their return values mortal.
Diffstat (limited to 'av.c')
-rw-r--r-- | av.c | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -791,11 +791,11 @@ Perl_av_fill(pTHX_ register AV *av, I32 fill) /* =for apidoc av_delete -Deletes the element indexed by C<key> from the array. Returns the -deleted element. If C<flags> equals C<G_DISCARD>, the element is freed -and null is returned. Perl equivalent: C<my $elem = delete($myarray[$idx]);> -for the non-C<G_DISCARD> version and a void-context C<delete($myarray[$idx]);> -for the C<G_DISCARD> version. +Deletes the element indexed by C<key> from the array, makes the element mortal, +and returns it. If C<flags> equals C<G_DISCARD>, the element is freed and null +is returned. Perl equivalent: C<my $elem = delete($myarray[$idx]);> for the +non-C<G_DISCARD> version and a void-context C<delete($myarray[$idx]);> for the +C<G_DISCARD> version. =cut */ |