From 3746c1cf17f4880fe0c8bb4d32feee15bfe30196 Mon Sep 17 00:00:00 2001
From: zerbina <100542850+zerbina@users.noreply.github.com>
Date: Wed, 12 Jul 2023 13:04:53 +0000
Subject: [PATCH] mirconstr: document `voidOut`

---
 compiler/mir/mirconstr.nim | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/compiler/mir/mirconstr.nim b/compiler/mir/mirconstr.nim
index 6e16bf00a53..672b17c9f35 100644
--- 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: