diff --git a/lib/pure/os.nim b/lib/pure/os.nim index c3349beb3b7b9..58a565c7a3a5e 100644 --- a/lib/pure/os.nim +++ b/lib/pure/os.nim @@ -954,13 +954,15 @@ proc getTempDir*(): string {.rtl, extern: "nos$1", tags: [ReadEnvEffect, ReadIOEffect].} = ## Returns the temporary directory of the current user for applications to ## save temporary files in. - ## - ## 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 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 in order. ## On all platforms, `/tmp` will be returned if the procs fails. ## ## You can override this implementation ## by adding `-d:tempDir=mytempname` to your compiler invocation. + ## + ## **Note:** This proc does not check whether the returned path exists. ## ## See also: ## * `getHomeDir proc <#getHomeDir>`_