mirconstr: document voidOut

nim-works · Jul 12, 2023 · 3746c1c · 3746c1c
1 parent 4b313b7
commit 3746c1c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/compiler/mir/mirconstr.nim b/compiler/mir/mirconstr.nim
@@ -255,6 +255,9 @@ func name*(s: var MirNodeSeq, val: EValue) =
   s.add MirNode(kind: mnkName, typ: val.typ)
 
 func voidOut*(s: var MirNodeSeq, val: EValue) =
+  ## Ends the input MIR expression as a void-expression (i.e., the
+  ## computed result of the expression is discarded). Corresponds
+  ## to ``mnkVoid``.
   s.add MirNode(kind: mnkVoid)
 
 # special operators: