Improve os.getFileSize documentation to specify the unit.

This commit is contained in:
Dominik Picheta
2017-03-23 21:34:03 +01:00
parent ab31b776ef
commit d221e6a35c

View File

@@ -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)