From d221e6a35c62b892867b96aaba7ef94a29d5e468 Mon Sep 17 00:00:00 2001 From: Dominik Picheta Date: Thu, 23 Mar 2017 21:34:03 +0100 Subject: [PATCH] Improve os.getFileSize documentation to specify the unit. --- lib/pure/os.nim | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/pure/os.nim b/lib/pure/os.nim index 07670c5da..39cdf6d81 100644 --- a/lib/pure/os.nim +++ b/lib/pure/os.nim @@ -1616,7 +1616,8 @@ proc sleep*(milsecs: int) {.rtl, extern: "nos$1", tags: [TimeEffect].} = proc getFileSize*(file: string): BiggestInt {.rtl, extern: "nos$1", tags: [ReadIOEffect].} = - ## returns the file size of `file`. Can raise ``OSError``. + ## returns the file size of `file` (in bytes). An ``OSError`` exception is + ## raised in case of an error. when defined(windows): var a: WIN32_FIND_DATA var resA = findFirstFile(file, a)