From: Gurusamy Sarathy Date: Sat, 19 Feb 2000 17:35:50 +0000 (+0000) Subject: document behavior of splice(@ary) (from Gisle Aas) X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=453f904417cdcc40c685b37c28b80ff4c89a1c40;p=p5sagit%2Fp5-mst-13.2.git document behavior of splice(@ary) (from Gisle Aas) p4raw-id: //depot/perl@5152 --- diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index d384249..578d62e 100644 --- a/pod/perlfunc.pod +++ b/pod/perlfunc.pod @@ -4182,6 +4182,8 @@ well-defined. =item splice ARRAY,OFFSET +=item splice ARRAY + Removes the elements designated by OFFSET and LENGTH from an array, and replaces them with the elements of LIST, if any. In list context, returns the elements removed from the array. In scalar context, @@ -4189,7 +4191,9 @@ returns the last element removed, or C if no elements are removed. The array grows or shrinks as necessary. If OFFSET is negative then it starts that far from the end of the array. If LENGTH is omitted, removes everything from OFFSET onward. -If LENGTH is negative, leave that many elements off the end of the array. +If LENGTH is negative, leaves that many elements off the end of the array. +If both OFFSET and LENGTH are omitted, removes everything. + The following equivalences hold (assuming C<$[ == 0>): push(@a,$x,$y) splice(@a,@a,0,$x,$y)