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

parsutils: minor doc improvements

Browse source
This commit is contained in:
Andreas Rumpf 2018-10-24 21:50:47 +02:00
commit 9331f06c0b
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/pure/parseutils.nim
View file

@ -278,7 +278,7 @@ proc parseInt*(s: string, number: var int, start = 0): int {.
rtl, extern: "npuParseInt", noSideEffect.} = rtl, extern: "npuParseInt", noSideEffect.} =
## parses an integer starting at `start` and stores the value into `number`. ## parses an integer starting at `start` and stores the value into `number`.
## Result is the number of processed chars or 0 if there is no integer. ## Result is the number of processed chars or 0 if there is no integer.
## `EOverflow` is raised if an overflow occurs. ## `OverflowError` is raised if an overflow occurs.
var res: BiggestInt var res: BiggestInt
result = parseBiggestInt(s, res, start) result = parseBiggestInt(s, res, start)
if (sizeof(int) <= 4) and if (sizeof(int) <= 4) and
@ -289,7 +289,7 @@ proc parseInt*(s: string, number: var int, start = 0): int {.
proc parseSaturatedNatural*(s: string, b: var int, start = 0): int = proc parseSaturatedNatural*(s: string, b: var int, start = 0): int =
## parses a natural number into ``b``. This cannot raise an overflow ## parses a natural number into ``b``. This cannot raise an overflow
## error. Instead of an ``Overflow`` exception ``high(int)`` is returned. ## error. ``high(int)`` is returned for an overflow.
## The number of processed character is returned. ## The number of processed character is returned.
## This is usually what you really want to use instead of `parseInt`:idx:. ## This is usually what you really want to use instead of `parseInt`:idx:.
## Example: ## Example: