diff options
author | Scott Baker <scott@perturb.org> | 2023-01-23 15:56:06 -0800 |
---|---|---|
committer | Yves Orton <demerphq@gmail.com> | 2023-01-24 14:01:41 +0800 |
commit | 71724c058dddcd30d3a4024c98c91f4dabb493d0 (patch) | |
tree | c770cd8a5f2d600e4729215f814d160021601420 /pod/perlfunc.pod | |
parent | a405f1587e7ebdf2d76c4158dee7f80e14bb4003 (diff) | |
download | perl-71724c058dddcd30d3a4024c98c91f4dabb493d0.tar.gz |
Add some examples to `unshift()` docs
Diffstat (limited to 'pod/perlfunc.pod')
-rw-r--r-- | pod/perlfunc.pod | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index e6046b0bd4..1c885489b7 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -9761,12 +9761,19 @@ X<unshift> =for Pod::Functions prepend more elements to the beginning of a list -Does the opposite of a L<C<shift>|/shift ARRAY>. Or the opposite of a -L<C<push>|/push ARRAY,LIST>, -depending on how you look at it. Prepends list to the front of the -array and returns the new number of elements in the array. +Add one or more elements to the B<beginning> of an array. This is the +opposite of a L<C<shift>|/shift ARRAY>. Returns the new number of elements +in the updated array. - unshift(@ARGV, '-e') unless $ARGV[0] =~ /^-/; + my @animals = ("cat"); + unshift(@animals, "mouse"); # ("mouse", "cat") + + my @colors = ("red"); + unshift(@colors, ("blue", "green"); # ("blue", "green", "red") + + # Return value is the number of items in the updated array + my $color_count = unshift(@colors, ("yellow", "purple"); + say "There are $color_count colors in the updated array"; Note the LIST is prepended whole, not one element at a time, so the prepended elements stay in the same order. Use |