summary refs log tree commit diff stats
path: root/lib/pure
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2018-03-05 23:25:34 +0100
committerAraq <rumpf_a@web.de>2018-03-05 23:25:50 +0100
commita9974a33f10e380c1277d3cda296b7012033b2e5 (patch)
treed60fb214a8bfced2d4664f7fa9f1f6d6b777a88b /lib/pure
parent0132442c1d7173e4b8d3aa3ced1888ba3c221163 (diff)
downloadNim-a9974a33f10e380c1277d3cda296b7012033b2e5.tar.gz
more documentation fixes
Diffstat (limited to 'lib/pure')
-rw-r--r--lib/pure/collections/sharedtables.nim12
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/pure/collections/sharedtables.nim b/lib/pure/collections/sharedtables.nim
index 4f311af87..0292a27a2 100644
--- a/lib/pure/collections/sharedtables.nim
+++ b/lib/pure/collections/sharedtables.nim
@@ -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