From f07bdbe945ff3d459e42ce10e253bb427126a1b9 Mon Sep 17 00:00:00 2001 From: flywind Date: Thu, 25 Feb 2021 06:58:31 -0600 Subject: clarify the docs of existsOrCreateDir a bit (#17182) * remove unnecessary when statement * remove outdated codes * clarify the docs a bit --- lib/pure/os.nim | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'lib/pure/os.nim') diff --git a/lib/pure/os.nim b/lib/pure/os.nim index 66a803058..42e3994c1 100644 --- a/lib/pure/os.nim +++ b/lib/pure/os.nim @@ -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>`_ -- cgit 1.4.1-2-gfad0