on master help sign in
Fix Pre-Release to 0.8.0
191e3cbRanjeet Kumar Ranjan
src/Streamly/Data/Array/Foreign.hs+1−1
@@ -30,7 +30,7 @@
30--
30--
31-- This module is designed to be imported qualified:
31-- This module is designed to be imported qualified:
32--
32--
33−-- > import qualified Streamly.Array as A
33+-- > import qualified Streamly.Data.Array.Foreign as Array
34--
34--
35-- For experimental APIs see "Streamly.Internal.Data.Array.Foreign".
35-- For experimental APIs see "Streamly.Internal.Data.Array.Foreign".
36
36
src/Streamly/FileSystem/Handle.hs+1−1
@@ -21,7 +21,7 @@
21--
21--
22-- = Programmer Notes
22-- = Programmer Notes
23--
23--
24−-- > import qualified Streamly.FileSystem.Handle as FH
24+-- > import qualified Streamly.FileSystem.Handle as Handle
25--
25--
26-- For additional, experimental APIs take a look at
26-- For additional, experimental APIs take a look at
27-- "Streamly.Internal.FileSystem.Handle" module.
27-- "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
59
59
60-- | Unfold standard input into a stream of 'Word8'.
60-- | Unfold standard input into a stream of 'Word8'.
61--
61--
62−-- /Pre-release/
62+-- @since 0.8.0
63{-# INLINE read #-}
63{-# INLINE read #-}
64read :: MonadIO m => Unfold m () Word8
64read :: MonadIO m => Unfold m () Word8
65read = Unfold.lmap (\() -> stdin) Handle.read
65read = Unfold.lmap (\() -> stdin) Handle.read
@@ -87,7 +87,7 @@ getChars = Unicode.decodeUtf8 getBytes
87
87
88-- | Unfolds standard input into a stream of 'Word8' arrays.
88-- | Unfolds standard input into a stream of 'Word8' arrays.
89--
89--
90−-- /Pre-release/
90+-- @since 0.8.0
91{-# INLINE readChunks #-}
91{-# INLINE readChunks #-}
92readChunks :: MonadIO m => Unfold m () (Array Word8)
92readChunks :: MonadIO m => Unfold m () (Array Word8)
93readChunks = Unfold.lmap (\() -> stdin) Handle.readChunks
93readChunks = Unfold.lmap (\() -> stdin) Handle.readChunks
@@ -129,14 +129,14 @@ getChunksLn = (Stream.splitWithSuffix (== '\n') f) getChars
129
129
130-- | Fold a stream of 'Word8' to standard output.
130-- | Fold a stream of 'Word8' to standard output.
131--
131--
132−-- /Pre-release/
132+-- @since 0.8.0
133{-# INLINE write #-}
133{-# INLINE write #-}
134write :: MonadIO m => Fold m Word8 ()
134write :: MonadIO m => Fold m Word8 ()
135write = Handle.write stdout
135write = Handle.write stdout
136
136
137-- | Fold a stream of 'Word8' to standard error.
137-- | Fold a stream of 'Word8' to standard error.
138--
138--
139−-- /Pre-release/
139+-- @since 0.8.0
140{-# INLINE writeErr #-}
140{-# INLINE writeErr #-}
141writeErr :: MonadIO m => Fold m Word8 ()
141writeErr :: MonadIO m => Fold m Word8 ()
142writeErr = Handle.write stderr
142writeErr = Handle.write stderr
@@ -164,14 +164,14 @@ putChars = putBytes . Unicode.encodeUtf8
164
164
165-- | Fold a stream of @Array Word8@ to standard output.
165-- | Fold a stream of @Array Word8@ to standard output.
166--
166--
167−-- /Pre-release/
167+-- @since 0.8.0
168{-# INLINE writeChunks #-}
168{-# INLINE writeChunks #-}
169writeChunks :: MonadIO m => Fold m (Array Word8) ()
169writeChunks :: MonadIO m => Fold m (Array Word8) ()
170writeChunks = Handle.writeChunks stdout
170writeChunks = Handle.writeChunks stdout
171
171
172-- | Fold a stream of @Array Word8@ to standard error.
172-- | Fold a stream of @Array Word8@ to standard error.
173--
173--
174−-- /Pre-release/
174+-- @since 0.8.0
175{-# INLINE writeErrChunks #-}
175{-# INLINE writeErrChunks #-}
176writeErrChunks :: MonadIO m => Fold m (Array Word8) ()
176writeErrChunks :: MonadIO m => Fold m (Array Word8) ()
177writeErrChunks = Handle.writeChunks stderr
177writeErrChunks = Handle.writeChunks stderr
src/Streamly/Internal/Data/Array/Foreign/Type.hs+1−1
@@ -395,7 +395,7 @@ length arr = MA.length (unsafeThaw arr)
395
395
396-- | Unfold an array into a stream in reverse order.
396-- | Unfold an array into a stream in reverse order.
397--
397--
398−-- /Pre-release/
398+-- @since 0.8.0
399{-# INLINE_NORMAL readRev #-}
399{-# INLINE_NORMAL readRev #-}
400readRev :: forall m a. (Monad m, Storable a) => Unfold m (Array a) a
400readRev :: forall m a. (Monad m, Storable a) => Unfold m (Array a) a
401readRev = Unfold.lmap unsafeThaw MA.readRev
401readRev = Unfold.lmap unsafeThaw MA.readRev
src/Streamly/Internal/Data/Fold.hs+2−2
@@ -589,7 +589,7 @@ stdDev = sqrt <$> variance
589--
589--
590-- See https://en.wikipedia.org/wiki/Rolling_hash
590-- See https://en.wikipedia.org/wiki/Rolling_hash
591--
591--
592−-- /Pre-release/
592+-- @since 0.8.0
593{-# INLINABLE rollingHashWithSalt #-}
593{-# INLINABLE rollingHashWithSalt #-}
594rollingHashWithSalt :: (Monad m, Enum a) => Int64 -> Fold m a Int64
594rollingHashWithSalt :: (Monad m, Enum a) => Int64 -> Fold m a Int64
595rollingHashWithSalt = foldl' step
595rollingHashWithSalt = foldl' step
@@ -609,7 +609,7 @@ defaultSalt = -2578643520546668380
609--
609--
610-- > rollingHash = Fold.rollingHashWithSalt defaultSalt
610-- > rollingHash = Fold.rollingHashWithSalt defaultSalt
611--
611--
612−-- /Pre-release/
612+-- @since 0.8.0
613{-# INLINABLE rollingHash #-}
613{-# INLINABLE rollingHash #-}
614rollingHash :: (Monad m, Enum a) => Fold m a Int64
614rollingHash :: (Monad m, Enum a) => Fold m a Int64
615rollingHash = rollingHashWithSalt defaultSalt
615rollingHash = rollingHashWithSalt defaultSalt
src/Streamly/Internal/Data/Pipe.hs+1−1
@@ -19,7 +19,7 @@
19-- fold to produce a fold, or multiple pipes can be merged or zipped into a
19-- fold to produce a fold, or multiple pipes can be merged or zipped into a
20-- single pipe.
20-- single pipe.
21--
21--
22−-- > import qualified Streamly.Internal.Data.Pipe as P
22+-- > import qualified Streamly.Internal.Data.Pipe as Pipe
23
23
24module Streamly.Internal.Data.Pipe
24module Streamly.Internal.Data.Pipe
25 (
25 (
src/Streamly/Internal/Data/Stream/IsStream/Reduce.hs+6−6
@@ -573,11 +573,11 @@ groups = groupsBy (==)
573--
573--
574-- splitOn is an inverse of intercalating single element:
574-- splitOn is an inverse of intercalating single element:
575--
575--
576−-- @Stream.intercalate (Stream.fromPure '.') Unfold.fromList . Stream.splitOn (== '.') Fold.toList === id@
576+-- > Stream.intercalate (Stream.fromPure '.') Unfold.fromList . Stream.splitOn (== '.') Fold.toList === id
577--
577--
578-- Assuming the input stream does not contain the separator:
578-- Assuming the input stream does not contain the separator:
579--
579--
580−-- @Stream.splitOn (== '.') Fold.toList . Stream.intercalate (Stream.fromPure '.') Unfold.fromList === id@
580+-- > Stream.splitOn (== '.') Fold.toList . Stream.intercalate (Stream.fromPure '.') Unfold.fromList === id
581--
581--
582-- @since 0.7.0
582-- @since 0.7.0
583
583
@@ -639,11 +639,11 @@ splitOn predicate f =
639--
639--
640-- 'splitOnSuffix' is an inverse of 'intercalateSuffix' with a single element:
640-- 'splitOnSuffix' is an inverse of 'intercalateSuffix' with a single element:
641--
641--
642−-- @Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnSuffix (== '.') Fold.toList === id@
642+-- > Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnSuffix (== '.') Fold.toList === id
643--
643--
644-- Assuming the input stream does not contain the separator:
644-- Assuming the input stream does not contain the separator:
645--
645--
646−-- @Stream.splitOnSuffix (== '.') Fold.toList . Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList === id@
646+-- > Stream.splitOnSuffix (== '.') Fold.toList . Stream.intercalateSuffix (Stream.fromPure '.') Unfold.fromList === id
647--
647--
648-- @since 0.7.0
648-- @since 0.7.0
649
649
@@ -695,11 +695,11 @@ splitOnSuffix predicate f = foldMany (FL.takeEndBy_ predicate f)
695--
695--
696-- 'splitOnPrefix' is an inverse of 'intercalatePrefix' with a single element:
696-- 'splitOnPrefix' is an inverse of 'intercalatePrefix' with a single element:
697--
697--
698−-- @Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnPrefix (== '.') Fold.toList === id@
698+-- > Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList . Stream.splitOnPrefix (== '.') Fold.toList === id
699--
699--
700-- Assuming the input stream does not contain the separator:
700-- Assuming the input stream does not contain the separator:
701--
701--
702−-- @Stream.splitOnPrefix (== '.') Fold.toList . Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList === id@
702+-- > Stream.splitOnPrefix (== '.') Fold.toList . Stream.intercalatePrefix (Stream.fromPure '.') Unfold.fromList === id
703--
703--
704-- /Unimplemented/
704-- /Unimplemented/
705
705