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

Fix option documentation in nre (fixes #9053)

Browse source
This commit is contained in:
Flaviu Tamas 2018-10-01 21:38:56 -04:00
commit a0ac0b9696
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/impure/nre.nim
View file

@ -151,18 +151,18 @@ type
## the whole match is returned. If the given capture was not matched, ## the whole match is returned. If the given capture was not matched,
## ``nil`` is returned. ## ``nil`` is returned.
## ##
## - ``"abc".match(re"(\w)").captures[0] == "a"`` ## - ``"abc".match(re"(\w)").get.captures[0] == "a"``
## - ``"abc".match(re"(?<letter>\w)").captures["letter"] == "a"`` ## - ``"abc".match(re"(?<letter>\w)").get.captures["letter"] == "a"``
## - ``"abc".match(re"(\w)\w").captures[-1] == "ab"`` ## - ``"abc".match(re"(\w)\w").get.captures[-1] == "ab"``
## ##
## ``captureBounds[]: Option[HSlice[int, int]]`` ## ``captureBounds[]: Option[HSlice[int, int]]``
## gets the bounds of the given capture according to the same rules as ## gets the bounds of the given capture according to the same rules as
## the above. If the capture is not filled, then ``None`` is returned. ## the above. If the capture is not filled, then ``None`` is returned.
## The bounds are both inclusive. ## The bounds are both inclusive.
## ##
## - ``"abc".match(re"(\w)").captureBounds[0] == 0 .. 0`` ## - ``"abc".match(re"(\w)").get.captureBounds[0].get == 0 .. 0``
## - ``"abc".match(re"").captureBounds[-1] == 0 .. -1`` ## - ``"abc".match(re"").get.captureBounds[-1].get == 0 .. -1``
## - ``"abc".match(re"abc").captureBounds[-1] == 0 .. 2`` ## - ``"abc".match(re"abc").get.captureBounds[-1].get == 0 .. 2``
## ##
## ``match: string`` ## ``match: string``
## the full text of the match. ## the full text of the match.