summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@gmail.com>2017-03-23 21:34:03 +0100
committerDominik Picheta <dominikpicheta@gmail.com>2017-03-23 21:34:03 +0100
commitd221e6a35c62b892867b96aaba7ef94a29d5e468 (patch)
tree65e0d775efce8eeb24bd010dc8287597ec586873 /lib
parentab31b776ef00df4a43f8afccb2e7c39a05616d2a (diff)
downloadNim-d221e6a35c62b892867b96aaba7ef94a29d5e468.tar.gz
Improve os.getFileSize documentation to specify the unit.
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/os.nim3
1 files changed, 2 insertions, 1 deletions
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)