summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorGrzegorz Adam Hankiewicz <gradha@imap.cc>2012-12-11 22:24:07 +0100
committerGrzegorz Adam Hankiewicz <gradha@imap.cc>2012-12-11 23:08:09 +0100
commitafff026dbd0466cabbce17a1026f7927598cceea (patch)
tree768d2817d0727ca45f02aaf189674f19c56102f9 /lib
parent545a7577e55597595a15c98a092f5e5da847c33e (diff)
downloadNim-afff026dbd0466cabbce17a1026f7927598cceea.tar.gz
Adds hyperlink to system module to explain TFileMode type.
Diffstat (limited to 'lib')
-rwxr-xr-xlib/pure/streams.nim3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/pure/streams.nim b/lib/pure/streams.nim
index 5db21d76a..212aab493 100755
--- a/lib/pure/streams.nim
+++ b/lib/pure/streams.nim
@@ -263,7 +263,8 @@ proc newFileStream*(f: TFile): PFileStream =
 
 proc newFileStream*(filename: string, mode: TFileMode): PFileStream = 
   ## creates a new stream from the file named `filename` with the mode `mode`.
-  ## If the file cannot be opened, nil is returned.
+  ## If the file cannot be opened, nil is returned. See the `system
+  ## <system.html>`_ module for a list of available TFileMode enums.
   var f: TFile
   if Open(f, filename, mode): result = newFileStream(f)