summary refs log tree commit diff stats
diff options
context:
space:
mode:
-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,