diff --git a/README.md b/README.md index 5ffb2e5a0b..9348829518 100644 --- a/README.md +++ b/README.md @@ -71,16 +71,13 @@ readability. ## Usage -### `proc match(str: string, pattern: Regex, start = 0, endpos = -1): RegexMatch` +#### `proc match(str: string, pattern: Regex, start = 0, endpos = -1): RegexMatch` + Tries to match the pattern, starting at start. This means that `"foo".match(re"f") == true`, but `"foo".match(re"o") == false`. -
-
`start`
-
The start point at which to start matching. `|abc` is `0`; `a|bc` is -`1`
- -
`endpos`
-
The maximum index for a match; `-1` means the end of the string, otherwise -it's an exclusive upper bound.
-
+ - `start` + - The start point at which to start matching. `|abc` is `0`; `a|bc` is `1` + - `endpos` + - The maximum index for a match; `-1` means the end of the string, otherwise + it's an exclusive upper bound.