From 7e7603ed2b6774454689978a08b46adb2fb953da Mon Sep 17 00:00:00 2001 From: Ico Doornekamp Date: Sat, 12 Jan 2019 08:17:20 +0100 Subject: [PATCH] Documented error source argument of macros.error() (#10279) --- lib/core/macros.nim | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/core/macros.nim b/lib/core/macros.nim index 92a35193f5..08ee051522 100644 --- a/lib/core/macros.nim +++ b/lib/core/macros.nim @@ -377,7 +377,9 @@ proc copyNimNode*(n: NimNode): NimNode {.magic: "NCopyNimNode", noSideEffect.} proc copyNimTree*(n: NimNode): NimNode {.magic: "NCopyNimTree", noSideEffect.} proc error*(msg: string, n: NimNode = nil) {.magic: "NError", benign.} - ## writes an error message at compile time + ## writes an error message at compile time. The optional ``n: NimNode`` + ## parameter is used as the source for file and line number information in + ## the compilation error message. proc warning*(msg: string, n: NimNode = nil) {.magic: "NWarning", benign.} ## writes a warning message at compile time