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

more documentation fixes

Browse source
This commit is contained in:
Araq 2018-03-05 23:25:34 +01:00
commit a9974a33f1
4 changed files with 10 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/pure/collections/sharedtables.nim
View file

@ -136,11 +136,13 @@ proc withKey*[A, B](t: var SharedTable[A, B], key: A,
## procedure.
##
## The ``mapper`` takes 3 arguments:
## #. ``key`` - the current key, if it exists, or the key passed to
## ``withKey`` otherwise;
## #. ``val`` - the current value, if the key exists, or default value
## of the type otherwise;
## #. ``pairExists`` - ``true`` if the key exists, ``false`` otherwise.
##
## 1. ``key`` - the current key, if it exists, or the key passed to
## ``withKey`` otherwise;
## 2. ``val`` - the current value, if the key exists, or default value
## of the type otherwise;
## 3. ``pairExists`` - ``true`` if the key exists, ``false`` otherwise.
##
## The ``mapper`` can can modify ``val`` and ``pairExists`` values to change
## the mapping of the key or delete it from the table.
## When adding a value, make sure to set ``pairExists`` to ``true`` along