jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme formatting

Browse source
This commit is contained in:
Flaviu Tamas 2015-01-16 19:14:16 -05:00
commit 4a67b723a0
1 changed files with 7 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -71,16 +71,13 @@ readability.
## Usage ## 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 Tries to match the pattern, starting at start. This means that
`"foo".match(re"f") == true`, but `"foo".match(re"o") == false`. `"foo".match(re"f") == true`, but `"foo".match(re"o") == false`.
<dl> - `start`
<dt>`start`</dt> - The start point at which to start matching. `|abc` is `0`; `a|bc` is `1`
<dd>The start point at which to start matching. `|abc` is `0`; `a|bc` is - `endpos`
`1`</dd> - The maximum index for a match; `-1` means the end of the string, otherwise
it's an exclusive upper bound.
<dt>`endpos`</dt>
<dd>The maximum index for a match; `-1` means the end of the string, otherwise
it's an exclusive upper bound.</dd>
</dl>