summary refs log tree commit diff stats
path: root/doc/manual
diff options
context:
space:
mode:
authorAndreas Rumpf <rumpf_a@web.de>2016-01-16 13:43:22 +0100
committerAndreas Rumpf <rumpf_a@web.de>2016-01-16 13:43:22 +0100
commit2910096ccec456aa6493d06c9cc36bb70acd2988 (patch)
treed9265760a28342522ca793f0b64d713c140e4488 /doc/manual
parent00651d4afc4b384a81b893d94c27af22b812f577 (diff)
downloadNim-2910096ccec456aa6493d06c9cc36bb70acd2988.tar.gz
updated the documentation for the 'do' notation
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/procs.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/manual/procs.txt b/doc/manual/procs.txt
index ee74b2ea6..654893286 100644
--- a/doc/manual/procs.txt
+++ b/doc/manual/procs.txt
@@ -236,8 +236,6 @@ executable code.
 Do notation
 -----------
 
-**Note:** The future of the ``do`` notation is uncertain.
-
 As a special more convenient notation, proc expressions involved in procedure
 calls can use the ``do`` keyword:
 
@@ -251,10 +249,12 @@ calls can use the ``do`` keyword:
 ``do`` is written after the parentheses enclosing the regular proc params.
 The proc expression represented by the do block is appended to them.
 
-More than one ``do`` block can appear in a single call:
+``do`` with parentheses is an anonymous ``proc``; however a ``do`` without
+parentheses is just a block of code. The ``do`` notation can be used to
+pass multiple blocks to a macro:
 
 .. code-block:: nim
-  proc performWithUndo(task: proc(), undo: proc()) = ...
+  macro performWithUndo(task, undo: untyped) = ...
 
   performWithUndo do:
     # multiple-line block of code