diff options
| author | Ico Doornekamp <github@zevv.nl> | 2019-01-12 08:17:20 +0100 |
|---|---|---|
| committer | Andreas Rumpf <rumpf_a@web.de> | 2019-01-12 08:17:20 +0100 |
| commit | 7e7603ed2b6774454689978a08b46adb2fb953da (patch) | |
| tree | becddb31cd64f1b066359042c479d558cd63994a /lib/core/macros.nim | |
| parent | 647066e378bdbc85646dd88ea90eb15eddbbbc50 (diff) | |
| download | Nim-7e7603ed2b6774454689978a08b46adb2fb953da.tar.gz | |
Documented error source argument of macros.error() (#10279)
Diffstat (limited to 'lib/core/macros.nim')
| -rw-r--r-- | lib/core/macros.nim | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/core/macros.nim b/lib/core/macros.nim index 92a35193f..08ee05152 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 |