summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authorCharles Blake <cblake@csail.mit.edu>2015-08-02 12:21:49 -0400
committerCharles Blake <cblake@csail.mit.edu>2015-08-02 12:21:49 -0400
commitad67bfcf4637532538ad09ffd34dd592b201f2d2 (patch)
treeaf289140876a6ae9575ca8b4e7a783940e3bf30c /lib
parent63c4f204e8cb7d505b13a6707783e50b58b413ae (diff)
downloadNim-ad67bfcf4637532538ad09ffd34dd592b201f2d2.tar.gz
Quote the \ in doc comments.
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/memfiles.nim10
1 files changed, 5 insertions, 5 deletions
diff --git a/lib/pure/memfiles.nim b/lib/pure/memfiles.nim
index f9f4965c4..d2d2a9c8f 100644
--- a/lib/pure/memfiles.nim
+++ b/lib/pure/memfiles.nim
@@ -263,8 +263,8 @@ proc toString*(ms: MemSlice): string {.inline.} =
 
 iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} =
   ## Iterates over [optional eat]delim-delimited slices in a MemFile.
-  ## Default delimiting is [\r]\l which parse Unix or Windows text file lines.
-  ## Pass eat='\0' to be strictly delim-delimited.
+  ## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines.
+  ## Pass eat='\\0' to be strictly delim-delimited.
   ## This zero copy, memchr-limited method is probably the fastest way to
   ## iterate through lines in a file, however the returned (data,size) objects
   ## are NOT Nim strings or even terminated C strings.  So, be careful how data
@@ -291,8 +291,8 @@ iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} =
 
 iterator lines*(mfile: MemFile, buf: var TaintedString, delim='\l', eat='\r'): TaintedString {.inline.} =
   ## Replace contents of passed buffer with each new line, like readLine(File).
-  ## Default delimiting is [\r]\l which parse Unix or Windows text file lines.
-  ## Pass eat='\0' to be strictly delim-delimited.
+  ## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines.
+  ## Pass eat='\\0' to be strictly delim-delimited.
   for ms in memSlices(mfile, delim, eat):
     buf.setLen(ms.size)
     c_memcpy(addr(buf[0]), ms.data, ms.size)
@@ -301,7 +301,7 @@ iterator lines*(mfile: MemFile, buf: var TaintedString, delim='\l', eat='\r'): T
 
 iterator lines*(mfile: MemFile, delim='\l', eat='\r'): TaintedString {.inline.} =
   ## Return each line in a file as a Nim string, like lines(File).
-  ## Default delimiting is [\r]\l which parse Unix or Windows text file lines.
+  ## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines.
   ## Pass eat='\0' to be strictly delim-delimited.
   var buf = TaintedString(newStringOfCap(80))
   for line in lines(mfile, buf, delim, eat):