summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorYasuhiro Horimoto <horimoto@clear-code.com>2018-10-10 02:30:03 +0900
committerAndreas Rumpf <rumpf_a@web.de>2018-10-09 19:30:02 +0200
commitfe19670c5227e73733a1fe44d4bc6fb7c13d512e (patch)
treea3735426ddc39884aac2a669a3843568323350d1
parenta98b1a7764a02c301f028c825fe93c84b0aa9547 (diff)
downloadNim-fe19670c5227e73733a1fe44d4bc6fb7c13d512e.tar.gz
Fixes #8841 (#9101)
Modify comments for readChar and peekChar to the same as the comment for them in the source code.
-rw-r--r--lib/pure/streams.nim4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/pure/streams.nim b/lib/pure/streams.nim
index 09626136f..9950c5877 100644
--- a/lib/pure/streams.nim
+++ b/lib/pure/streams.nim
@@ -158,12 +158,12 @@ proc peek[T](s: Stream, result: var T) =
 
 proc readChar*(s: Stream): char =
   ## reads a char from the stream `s`. Raises `EIO` if an error occurred.
-  ## Returns '\0' as an EOF marker.
+  ## Returns '\\0' as an EOF marker.
   if readData(s, addr(result), sizeof(result)) != 1: result = '\0'
 
 proc peekChar*(s: Stream): char =
   ## peeks a char from the stream `s`. Raises `EIO` if an error occurred.
-  ## Returns '\0' as an EOF marker.
+  ## Returns '\\0' as an EOF marker.
   if peekData(s, addr(result), sizeof(result)) != 1: result = '\0'
 
 proc readBool*(s: Stream): bool =