summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorTimothee Cour <timothee.cour2@gmail.com>2018-10-18 03:18:40 -0700
committerAndreas Rumpf <rumpf_a@web.de>2018-10-18 12:18:40 +0200
commit7d8e281239de4d8d4ba2a32671812726a8c20263 (patch)
treeb8316be68eb95074fc6db039d3874e20dc985c2a
parentbe77710c8c189bf797162e1844676c780d8ee920 (diff)
downloadNim-7d8e281239de4d8d4ba2a32671812726a8c20263.tar.gz
[nimscript] document currentSourcePath in thisDir (#9402)
-rw-r--r--lib/system/nimscript.nim4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/system/nimscript.nim b/lib/system/nimscript.nim
index c876d6d06..0adc7a83c 100644
--- a/lib/system/nimscript.nim
+++ b/lib/system/nimscript.nim
@@ -282,7 +282,9 @@ proc projectPath*(): string =
   builtin
 
 proc thisDir*(): string =
-  ## Retrieves the location of the current ``nims`` script file.
+  ## Retrieves the directory of the current ``nims`` script file. Its path is
+  ## obtained via ``currentSourcePath`` (although, currently,
+  ## ``currentSourcePath`` resolves symlinks, unlike ``thisDir``).
   builtin
 
 proc cd*(dir: string) {.raises: [OSError].} =