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

7
lib/pure/os.nim
View file

@ -1236,13 +1236,18 @@ proc fileNewer*(a, b: string): bool {.rtl, extern: "nos$1", noNimScript.} =
result = getLastModificationTime(a) > getLastModificationTime(b)
proc getCurrentDir*(): string {.rtl, extern: "nos$1", tags: [], noNimScript.} =
## Returns the `current working directory`:idx:.
## Returns the `current working directory`:idx: i.e. where the built
## binary is run.
##
## So the path returned by this proc is determined at run time.
##
## See also:
## * `getHomeDir proc <#getHomeDir>`_
## * `getConfigDir proc <#getConfigDir>`_
## * `getTempDir proc <#getTempDir>`_
## * `setCurrentDir proc <#setCurrentDir,string>`_
## * `currentSourcePath template <system.html#currentSourcePath.t>`_
## * `getProjectPath proc <macros.html#getProjectPath>`_
when defined(windows):
var bufsize = MAX_PATH.int32
when useWinUnicode: