Note that lines doesn't handle CR (#28)

haskell · Jul 7, 2020 · f80c455 · f80c455
1 parent f2950af
commit f80c455
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/Data/ByteString/Char8.hs b/Data/ByteString/Char8.hs
@@ -867,7 +867,9 @@ lastnonspace ptr n
 -}
 
 -- | 'lines' breaks a ByteString up into a list of ByteStrings at
--- newline Chars. The resulting strings do not contain newlines.
+-- newline Chars (@'\\n'@). The resulting strings do not contain newlines.
+--
+-- Note that it __does not__ regard CR (@'\\r'@) as a newline character.
 --
 lines :: ByteString -> [ByteString]
 lines ps

diff --git a/Data/ByteString/Lazy/Char8.hs b/Data/ByteString/Lazy/Char8.hs
@@ -656,11 +656,13 @@ zipWith :: (Char -> Char -> a) -> ByteString -> ByteString -> [a]
 zipWith f = L.zipWith ((. w2c) . f . w2c)
 
 -- | 'lines' breaks a ByteString up into a list of ByteStrings at
--- newline Chars. The resulting strings do not contain newlines.
+-- newline Chars (@'\\n'@). The resulting strings do not contain newlines.
 --
 -- As of bytestring 0.9.0.3, this function is stricter than its
 -- list cousin.
 --
+-- Note that it __does not__ regard CR (@'\\r'@) as a newline character.
+--
 lines :: ByteString -> [ByteString]
 lines Empty          = []
 lines (Chunk c0 cs0) = loop0 c0 cs0