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

Update documentation

Browse source
This commit is contained in:
Flaviu Tamas 2015-01-31 18:07:55 -05:00
commit bc37a33853
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.asciidoc
View file

@ -96,10 +96,11 @@ If `sub` is a string, the syntax is as follows:
Escapes the string so it doesn't match any special characters. Incompatible
with the Extra flag (`X`).
=== RegexMatch
=== Option[RegexMatch]
Represents the result of an execution. On failure, it is `nil`. The available
fields are as follows:
Represents the result of an execution. On failure, it is `None[RegexMatch]`,
but if you want automated derefrence, import `optional_t.nonstrict`. The
available fields are as follows:
`pattern: Regex` :: the pattern that is being matched
`str: string` :: the string that was matched against