Merge pull request #7056 from porterjamesj/re-idx-doc

Document idx option to match.

Author: timholy

doc/manual/strings.rst

@@ -595,6 +595,20 @@ text after the comment character. We could do the following:
     julia> m = match(r"^\s*(?:#\s*(.*?)\s*$|$)", "# a comment ")
     RegexMatch("# a comment ", 1="a comment")
 
+When calling ``match``, you have the option to specify an index at
+which to start the search. For example:
+
+.. doctest::
+
+   julia> m = match(r"[0-9]","aaaa1aaaa2aaaa3",1)
+   RegexMatch("1")
+
+   julia> m = match(r"[0-9]","aaaa1aaaa2aaaa3",6)
+   RegexMatch("2")
+
+   julia> m = match(r"[0-9]","aaaa1aaaa2aaaa3",11)
+   RegexMatch("3")
+
 You can extract the following info from a ``RegexMatch`` object:
 
 -  the entire substring matched: ``m.match``

doc/stdlib/base.rst

@@ -1174,7 +1174,7 @@ Strings
 
 .. function:: match(r::Regex, s::String[, idx::Integer[, addopts]])
 
-   Search for the first match of the regular expression ``r`` in ``s`` and return a RegexMatch object containing the match, or nothing if the match failed. The matching substring can be retrieved by accessing ``m.match`` and the captured sequences can be retrieved by accessing ``m.captures``
+   Search for the first match of the regular expression ``r`` in ``s`` and return a RegexMatch object containing the match, or nothing if the match failed. The matching substring can be retrieved by accessing ``m.match`` and the captured sequences can be retrieved by accessing ``m.captures`` The optional ``idx`` argument specifies an index at which to start the search.
 
 .. function:: eachmatch(r::Regex, s::String[, overlap::Bool=false])