summary refs log tree commit diff stats
path: root/lib/core
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2013-07-28 14:41:54 +0100
committerDominik Picheta <dominikpicheta@googlemail.com>2013-07-31 23:44:09 +0100
commitec86d5db0f6a150db4db804876f2241451a07ffe (patch)
tree5d775055cfc1a2dd245ac61ca14d87cca5db1cf3 /lib/core
parent9589acd00e23e513acd99b16c67586baa515f36a (diff)
downloadNim-ec86d5db0f6a150db4db804876f2241451a07ffe.tar.gz
Improved documentation for macros.newProc.
Diffstat (limited to 'lib/core')
-rw-r--r--lib/core/macros.nim3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/core/macros.nim b/lib/core/macros.nim
index 856bc0929..879c66df7 100644
--- a/lib/core/macros.nim
+++ b/lib/core/macros.nim
@@ -480,6 +480,9 @@ proc ExpectKind*(n: PNimrodNode; k: set[TNimrodNodeKind]) {.compileTime.} =
 proc newProc*(name = newEmptyNode(); params: openarray[PNimrodNode] = [];  
     body: PNimrodNode = newStmtList(), procType = nnkProcDef): PNimrodNode {.compileTime.} =
   ## shortcut for creating a new proc
+  ##
+  ## The ``params`` array should start with the return type of the proc, 
+  ## followed by a list of IdentDefs which specify the params.
   assert procType in RoutineNodes
   result = newNimNode(procType).add(
     name,