jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[backport] Add docs to better distinguish among getProjectPath, getCurrentDir and currentSourcePath (#12565)

Browse source 
Fixes https://github.com/nim-lang/Nim/issues/10477.
This commit is contained in:
Kaushal Modi 2019-10-31 16:00:18 -04:00 • committed by Miran
commit d914e9a65f
3 changed files with 42 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/system.nim
View file

@ -4183,7 +4183,19 @@ when declared(File):
template `&=`*(f: File, x: typed) = write(f, x)
template currentSourcePath*: string = instantiationInfo(-1, true).filename
## returns the full file-system path of the current source
## Returns the full file-system path of the current source.
##
## To get the directory containing the current source, use it with
## `os.parentDir() <os.html#parentDir%2Cstring>`_ as ``currentSourcePath.parentDir()``.
##
## The path returned by this template is set at compile time.
##
## See the docstring of `macros.getProjectPath() <macros.html#getProjectPath>`_
## for an example to see the distinction between the ``currentSourcePath``
## and ``getProjectPath``.
##
## See also:
## * `getCurrentDir proc <os.html#getCurrentDir>`_
when compileOption("rangechecks"):
template rangeCheck*(cond) =