Skip to content

Commit 9c11638

Browse files
jhrcekchessai
authored andcommitted
Various documentation improvements (#82)
1 parent b27e1e2 commit 9c11638

3 files changed

Lines changed: 65 additions & 149 deletions

File tree

src/Streaming.hs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ import Data.Bifunctor
132132
> -> Stream f m r -> Stream g m r -> Stream h m r
133133
> intercalates :: Stream f m () -> Stream (Stream f m) m r -> Stream f m r
134134
> unzips :: Stream (Compose f g) m r -> Stream f (Stream g m) r
135-
> separate :: Stream (Sum f g) m r -> Stream f (Stream g) m r -- cp. partitionEithers
135+
> separate :: Stream (Sum f g) m r -> Stream f (Stream g m) r -- cp. partitionEithers
136136
> unseparate :: Stream f (Stream g) m r -> Stream (Sum f g) m r
137137
> groups :: Stream (Sum f g) m r -> Stream (Sum (Stream f m) (Stream g m)) m r
138138
@@ -167,5 +167,3 @@ import Data.Bifunctor
167167
> concats :: (Monad m, MonadTrans t, Monad (t m)) => Stream (t m) m a -> t m a
168168
> concats stream = destroy stream join (join . lift) return
169169
-}
170-
171-

src/Streaming/Internal.hs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,9 @@ instance Show ShowSWrapper where
227227
--
228228
-- @
229229
-- Stream (Of a) m r
230-
-- ^ ^
231-
-- | `--- This is what `Functor` and `Applicative` use
232-
-- `--- This is what functions like S.map/S.zipWith use
230+
-- ^ ^
231+
-- | `--- This is what `Functor` and `Applicative` use
232+
-- `--- This is what functions like S.map/S.zipWith use
233233
-- @
234234
instance (Functor f, Monad m) => Functor (Stream f m) where
235235
fmap f = loop where
@@ -531,7 +531,7 @@ mapsM phi = loop where
531531
532532
> mapsPost id = id
533533
> mapsPost f . mapsPost g = mapsPost (f . g)
534-
> mapsPost f = mapsPost f
534+
> mapsPost f = maps f
535535
536536
@mapsPost@ is essentially the same as 'maps', but it imposes a 'Functor' constraint on
537537
its target functor rather than its source functor. It should be preferred if 'fmap'

0 commit comments

Comments
 (0)