From 5ec4b7946fd8c916ac0cf0d94b42837a571adc68 Mon Sep 17 00:00:00 2001 From: Charles Blake Date: Tue, 4 Aug 2015 13:25:41 -0400 Subject: [PATCH] Add note about what is included. --- lib/pure/memfiles.nim | 3 +++ 1 file changed, 3 insertions(+) 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