This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
document index() with out of bounds POSITION
authorYitzchak Scott-Thoennes <sthoenna@efn.org>
Fri, 2 Sep 2005 14:23:00 +0000 (14:23 +0000)
committerRafael Garcia-Suarez <rgarciasuarez@gmail.com>
Fri, 2 Sep 2005 19:57:21 +0000 (19:57 +0000)
Message-ID: <20050902122311.GA3104@efn.org>

p4raw-id: //depot/perl@25351

pod/perlfunc.pod

index 09d98b0..f687728 100644 (file)
@@ -2339,7 +2339,9 @@ The index function searches for one string within another, but without
 the wildcard-like behavior of a full regular-expression pattern match.
 It returns the position of the first occurrence of SUBSTR in STR at
 or after POSITION.  If POSITION is omitted, starts searching from the
-beginning of the string.  The return value is based at C<0> (or whatever
+beginning of the string.  POSITION before the beginning of the string
+or after its end is treated as if it were the beginning or the end,
+respectively.  POSITION and the return value are based at C<0> (or whatever
 you've set the C<$[> variable to--but don't do that).  If the substring
 is not found, C<index> returns one less than the base, ordinarily C<-1>.