summaryrefslogtreecommitdiff
path: root/pod/perlfunc.pod
diff options
context:
space:
mode:
authorScott Baker <scott@perturb.org>2023-01-23 15:49:55 -0800
committerYves Orton <demerphq@gmail.com>2023-02-07 23:42:19 +0800
commit66c1d2a57eb49d2facb14a07e915cf285e732f21 (patch)
tree7001e4d7310cb41a7492850993c6559d4472aec6 /pod/perlfunc.pod
parent9312140ba1ac523a74c69d552697f2767e128e04 (diff)
downloadperl-66c1d2a57eb49d2facb14a07e915cf285e732f21.tar.gz
Add some examples for push()
Diffstat (limited to 'pod/perlfunc.pod')
-rw-r--r--pod/perlfunc.pod20
1 files changed, 18 insertions, 2 deletions
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index 6149454c23..489aa8e786 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -6156,6 +6156,23 @@ X<push> X<stack>
=for Pod::Functions append one or more elements to an array
+Adds one or more items to the B<end> of an array.
+
+ my @animals = ("cat");
+ push(@animals, "mouse"); # ("cat", "mouse")
+
+ my @colors = ("red");
+ push(@colors, ("blue", "green"); # ("red", "blue", "green")
+
+ # Return value is the number of items in the updated array
+ my $color_count = push(@colors, ("yellow", "purple");
+ say "There are $color_count colors in the updated array";
+
+Returns the number of elements in the array following the completed
+L<C<push>|/push ARRAY,LIST>.
+
+A more technical explanation:
+
Treats ARRAY as a stack by appending the values of LIST to the end of
ARRAY. The length of ARRAY increases by the length of LIST. Has the same
effect as
@@ -6164,8 +6181,7 @@ effect as
$ARRAY[++$#ARRAY] = $value;
}
-but is more efficient. Returns the number of elements in the array following
-the completed L<C<push>|/push ARRAY,LIST>.
+but is more efficient.
Starting with Perl 5.14, an experimental feature allowed
L<C<push>|/push ARRAY,LIST> to take a