191e3cb · streamly · git.iko.soy

git.iko.soy/streamly

Fix Pre-Release to 0.8.0

Fix missing quotes from Stream.intercalateSuffix docs Fix review comments Revert Internal API to Pre-Release Fix Pre-Release to 0.8.0 for remainig revert Mut/Type.hs to Pre-release

commit191e3cbd5b3c74075b74f39b62470db14a990240 authorRanjeet Kumar Ranjan <ranjeetr@composewell.com> dateMon 31 May 2021, 21:54 (5 years ago) parent59ebde0

7 files changed+18−18

compare with master

unifiedsplit

src/Streamly/Data/Array/Foreign.hs+1−1 src/Streamly/FileSystem/Handle.hs+1−1 src/Streamly/Internal/Console/Stdio.hs+6−6 src/Streamly/Internal/Data/Array/Foreign/Type.hs+1−1 src/Streamly/Internal/Data/Fold.hs+2−2 src/Streamly/Internal/Data/Pipe.hs+1−1 src/Streamly/Internal/Data/Stream/IsStream/Reduce.hs+6−6

src/Streamly/Data/Array/Foreign.hs+1−1

@@ -30,7 +30,7 @@

3030--

3131-- This module is designed to be imported qualified:

3232--

33−-- > import qualified Streamly.Array as A

33+-- > import qualified Streamly.Data.Array.Foreign as Array

3434--

3535-- For experimental APIs see "Streamly.Internal.Data.Array.Foreign".

3636

src/Streamly/FileSystem/Handle.hs+1−1

@@ -21,7 +21,7 @@

2121--

2222-- = Programmer Notes

2323--

24−-- > import qualified Streamly.FileSystem.Handle as FH

24+-- > import qualified Streamly.FileSystem.Handle as Handle

2525--

2626-- For additional, experimental APIs take a look at

2727-- "Streamly.Internal.FileSystem.Handle" module.

src/Streamly/Internal/Console/Stdio.hs+6−6

@@ -59,7 +59,7 @@ import qualified Streamly.Internal.Unicode.Stream as Unicode

5959

6060-- | Unfold standard input into a stream of 'Word8'.

6161--

62−-- /Pre-release/

62+-- @since 0.8.0

6363{-# INLINE read #-}

6464read :: MonadIO m => Unfold m () Word8

6565read = Unfold.lmap (\() -> stdin) Handle.read

@@ -87,7 +87,7 @@ getChars = Unicode.decodeUtf8 getBytes

8787

8888-- | Unfolds standard input into a stream of 'Word8' arrays.

8989--

90−-- /Pre-release/

90+-- @since 0.8.0

9191{-# INLINE readChunks #-}

9292readChunks :: MonadIO m => Unfold m () (Array Word8)

9393readChunks = Unfold.lmap (\() -> stdin) Handle.readChunks

@@ -129,14 +129,14 @@ getChunksLn = (Stream.splitWithSuffix (== '\n') f) getChars

129129

130130-- | Fold a stream of 'Word8' to standard output.

131131--

132−-- /Pre-release/

132+-- @since 0.8.0

133133{-# INLINE write #-}

134134write :: MonadIO m => Fold m Word8 ()

135135write = Handle.write stdout

136136

137137-- | Fold a stream of 'Word8' to standard error.

138138--

139−-- /Pre-release/

139+-- @since 0.8.0

140140{-# INLINE writeErr #-}

141141writeErr :: MonadIO m => Fold m Word8 ()

142142writeErr = Handle.write stderr

@@ -164,14 +164,14 @@ putChars = putBytes . Unicode.encodeUtf8

164164

165165-- | Fold a stream of @Array Word8@ to standard output.

166166--

167−-- /Pre-release/

167+-- @since 0.8.0

168168{-# INLINE writeChunks #-}

169169writeChunks :: MonadIO m => Fold m (Array Word8) ()

170170writeChunks = Handle.writeChunks stdout

171171

172172-- | Fold a stream of @Array Word8@ to standard error.

173173--

174−-- /Pre-release/

174+-- @since 0.8.0

175175{-# INLINE writeErrChunks #-}

176176writeErrChunks :: MonadIO m => Fold m (Array Word8) ()

177177writeErrChunks = Handle.writeChunks stderr

src/Streamly/Internal/Data/Array/Foreign/Type.hs+1−1

@@ -395,7 +395,7 @@ length arr = MA.length (unsafeThaw arr)

395395

396396-- | Unfold an array into a stream in reverse order.

397397--

398−-- /Pre-release/

398+-- @since 0.8.0

399399{-# INLINE_NORMAL readRev #-}

400400readRev :: forall m a. (Monad m, Storable a) => Unfold m (Array a) a

401401readRev = Unfold.lmap unsafeThaw MA.readRev

src/Streamly/Internal/Data/Fold.hs+2−2

@@ -589,7 +589,7 @@ stdDev = sqrt <$> variance

589589--

590590-- See https://en.wikipedia.org/wiki/Rolling_hash

591591--

592−-- /Pre-release/

592+-- @since 0.8.0

593593{-# INLINABLE rollingHashWithSalt #-}

594594rollingHashWithSalt :: (Monad m, Enum a) => Int64 -> Fold m a Int64

595595rollingHashWithSalt = foldl' step

@@ -609,7 +609,7 @@ defaultSalt = -2578643520546668380

609609--

610610-- > rollingHash = Fold.rollingHashWithSalt defaultSalt

611611--

612−-- /Pre-release/

612+-- @since 0.8.0

613613{-# INLINABLE rollingHash #-}

614614rollingHash :: (Monad m, Enum a) => Fold m a Int64

615615rollingHash = rollingHashWithSalt defaultSalt

src/Streamly/Internal/Data/Pipe.hs+1−1

@@ -19,7 +19,7 @@

1919-- fold to produce a fold, or multiple pipes can be merged or zipped into a

2020-- single pipe.

2121--

22−-- > import qualified Streamly.Internal.Data.Pipe as P

22+-- > import qualified Streamly.Internal.Data.Pipe as Pipe

2323

2424module Streamly.Internal.Data.Pipe

2525 (

src/Streamly/Internal/Data/Stream/IsStream/Reduce.hs+6−6

@@ -573,11 +573,11 @@ groups = groupsBy (==)

573573--

574574-- splitOn is an inverse of intercalating single element:

575575--

576−-- @Stream.intercalate (Stream.fromPure '.') Unfold.fromList . Stream.splitOn (== '.') Fold.toList === id@

576+-- > Stream.intercalate (Stream.fromPure '.') Unfold.fromList . Stream.splitOn (== '.') Fold.toList === id

577577--

578578-- Assuming the input stream does not contain the separator:

579579--

580−-- @Stream.splitOn (== '.') Fold.toList . Stream.intercalate (Stream.fromPure '.') Unfold.fromList === id@

580+-- > Stream.splitOn (== '.') Fold.toList . Stream.intercalate (Stream.fromPure '.') Unfold.fromList === id

581581--

582582-- @since 0.7.0

583583

@@ -639,11 +639,11 @@ splitOn predicate f =

639639--

640640-- 'splitOnSuffix' is an inverse of 'intercalateSuffix' with a single element:

641641--

642−-- @Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnSuffix (== '.') Fold.toList === id@

642+-- > Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnSuffix (== '.') Fold.toList === id

643643--

644644-- Assuming the input stream does not contain the separator:

645645--

646−-- @Stream.splitOnSuffix (== '.') Fold.toList . Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList === id@

646+-- > Stream.splitOnSuffix (== '.') Fold.toList . Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList === id

647647--

648648-- @since 0.7.0

649649

@@ -695,11 +695,11 @@ splitOnSuffix predicate f = foldMany (FL.takeEndBy_ predicate f)

695695--

696696-- 'splitOnPrefix' is an inverse of 'intercalatePrefix' with a single element:

697697--

698−-- @Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnPrefix (== '.') Fold.toList === id@

698+-- > Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnPrefix (== '.') Fold.toList === id

699699--

700700-- Assuming the input stream does not contain the separator:

701701--

702−-- @Stream.splitOnPrefix (== '.') Fold.toList . Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList === id@

702+-- > Stream.splitOnPrefix (== '.') Fold.toList . Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList === id

703703--

704704-- /Unimplemented/

705705