summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2015-08-23 19:57:23 +0100
committerDominik Picheta <dominikpicheta@googlemail.com>2015-08-23 19:57:23 +0100
commitfe190ee83f2d0d1f2ee4c7e6e0c01cbb73504688 (patch)
tree46775ba6cf2e72fc7b3979cd7efec1e2b3396717
parent193f248ea0d510171b69e8e690eaaa05509be47f (diff)
downloadNim-fe190ee83f2d0d1f2ee4c7e6e0c01cbb73504688.tar.gz
Better docs for os.getCreationTime(). Fixes #1058.
-rw-r--r--lib/pure/os.nim6
1 files changed, 4 insertions, 2 deletions
diff --git a/lib/pure/os.nim b/lib/pure/os.nim
index c2c28c2b1..3d592a526 100644
--- a/lib/pure/os.nim
+++ b/lib/pure/os.nim
@@ -461,8 +461,10 @@ proc getLastAccessTime*(file: string): Time {.rtl, extern: "nos$1".} =
 
 proc getCreationTime*(file: string): Time {.rtl, extern: "nos$1".} =
   ## Returns the `file`'s creation time.
-  ## Note that under posix OS's, the returned time may actually be the time at
-  ## which the file's attribute's were last modified.
+  ##
+  ## **Note:** Under POSIX OS's, the returned time may actually be the time at
+  ## which the file's attribute's were last modified. See
+  ## `here <https://github.com/nim-lang/Nim/issues/1058>`_ for details.
   when defined(posix):
     var res: Stat
     if stat(file, res) < 0'i32: raiseOSError(osLastError())