@@ -62,7 +62,7 @@ module Streamly.FileSystem.File
6262 -- , readArrayUpto
6363 -- , readArrayOf
6464
65− -- , readArraysUpto
65+ , readArraysUpto
6666 -- , readArraysOf
6767 , readArrays
6868
@@ -175,9 +175,8 @@ writeArray h Array{..} = withForeignPtr aStart $ \p -> hPutBuf h p aLen
175175-------------------------------------------------------------------------------
176176
177177-- | @readArraysUpto size h@ reads a stream of arrays from file handle @h@.
178−-- The maximum size of a single array is limited to @size@.
179−-- 'fromHandleArraysUpto' ignores the prevailing 'TextEncoding' and 'NewlineMode'
180−-- on the 'Handle'.
178+-- The maximum size of a single array is specified by @size@. The actual size
179+-- read may be less than or equal to @size@.
181180{-# INLINABLE readArraysUpto #-}
182181readArraysUpto :: (IsStream t, MonadIO m)
183182 => Int -> Handle -> t m (Array Word8)
@@ -197,6 +196,8 @@ readArraysUpto size h = go
197196-- 'readArrays' ignores the prevailing 'TextEncoding' and 'NewlineMode'
198197-- on the 'Handle'.
199198--
199+-- > readArrays = readArraysUpto defaultChunkSize
200+--
200201-- @since 0.7.0
201202{-# INLINE readArrays #-}
202203readArrays :: (IsStream t, MonadIO m) => Handle -> t m (Array Word8)