Modify comments for readChar and peekChar to the same as the comment for them in the source code.
This commit is contained in:
Yasuhiro Horimoto
2018-10-10 02:30:03 +09:00
committed by Andreas Rumpf
parent a98b1a7764
commit fe19670c52

View File

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