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

clarify the docs of existsOrCreateDir a bit (#17182)

Browse source 
* remove unnecessary when statement

* remove outdated codes

* clarify the docs a bit
This commit is contained in:
flywind 2021-02-25 06:58:31 -06:00 • committed by GitHub
commit f07bdbe945
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/pure/os.nim
View file

@ -2436,11 +2436,10 @@ proc rawCreateDir(dir: string): bool {.noWeirdTarget.} =
proc existsOrCreateDir*(dir: string): bool {.rtl, extern: "nos$1",
tags: [WriteDirEffect, ReadDirEffect], noWeirdTarget.} =
## Check if a `directory`:idx: `dir` exists, and create it otherwise.
## Checks if a `directory`:idx: `dir` exists, and creates it otherwise.
##
## Does not create parent directories (fails if parent does not exist).
## Returns `true` if the directory already exists, and `false`
## otherwise.
## Does not create parent directories (raises `OSError` if parent directories do not exist).
## Returns `true` if the directory already exists, and `false` otherwise.
##
## See also:
## * `removeDir proc <#removeDir,string>`_