diff options
| author | Charles Blake <cblake@csail.mit.edu> | 2015-08-04 13:25:41 -0400 |
|---|---|---|
| committer | Charles Blake <cblake@csail.mit.edu> | 2015-08-04 13:25:41 -0400 |
| commit | 5ec4b7946fd8c916ac0cf0d94b42837a571adc68 (patch) | |
| tree | 8ffd417840612b13d79568e38525161b24ee091e | |
| parent | 0487ad418040b0512603ec7f640307ab34895400 (diff) | |
| download | Nim-5ec4b7946fd8c916ac0cf0d94b42837a571adc68.tar.gz | |
Add note about what is included.
| -rw-r--r-- | lib/pure/memfiles.nim | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/pure/memfiles.nim b/lib/pure/memfiles.nim index 15fa4c65e..00929eaa2 100644 --- a/lib/pure/memfiles.nim +++ b/lib/pure/memfiles.nim @@ -270,6 +270,9 @@ iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} = ## are not supported as a third option for each line. Such archaic MacOS9 ## files can be handled by passing delim='\\r', eat='\\0', though. ## + ## Delimiters are not part of the returned slice. A final, unterminated line + ## or record is returned just like any other. + ## ## Non-default delimiters can be passed to allow iteration over other sorts ## of "line-like" variable length records. Pass eat='\\0' to be strictly ## `delim`-delimited. (Eating an optional prefix equal to '\\0' is not |