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

[Minor] improve the docs of getTempDir (#17058)

Browse source 
* [Minor] improve the docs of getTempDir

* more clear

* Update lib/pure/os.nim

Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
This commit is contained in:
flywind 2021-02-16 13:17:40 -06:00 • committed by GitHub
commit 71feb96c63
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
lib/pure/os.nim
View file

@ -954,13 +954,15 @@ proc getTempDir*(): string {.rtl, extern: "nos$1",
tags: [ReadEnvEffect, ReadIOEffect].} = tags: [ReadEnvEffect, ReadIOEffect].} =
## Returns the temporary directory of the current user for applications to ## Returns the temporary directory of the current user for applications to
## save temporary files in. ## save temporary files in.
## ##
## On Windows, it calls [GetTempPath](https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-gettemppathw) ## On Windows, it calls [GetTempPath](https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-gettemppathw).
## On Posix based platforms, it will check `TMPDIR`, `TEMP`, `TMP` and `TEMPDIR` environment variables. ## On Posix based platforms, it will check `TMPDIR`, `TEMP`, `TMP` and `TEMPDIR` environment variables in order.
## On all platforms, `/tmp` will be returned if the procs fails. ## On all platforms, `/tmp` will be returned if the procs fails.
## ##
## You can override this implementation ## You can override this implementation
## by adding `-d:tempDir=mytempname` to your compiler invocation. ## by adding `-d:tempDir=mytempname` to your compiler invocation.
##
## **Note:** This proc does not check whether the returned path exists.
## ##
## See also: ## See also:
## * `getHomeDir proc <#getHomeDir>`_ ## * `getHomeDir proc <#getHomeDir>`_