f0fa660 · streamly · git.iko.soy

git.iko.soy/streamly

Minor edits to docs

commitf0fa66029109fa7e67fd4255a3e8546866d0cf71 authorHarendra Kumar <harendra.kumar@gmail.com> dateWed 2 May 2018, 17:06 (8 years ago) parent7febfe9

2 files changed+5−4

unifiedsplit

src/Streamly/Prelude.hs+1−1

@@ -20,9 +20,9 @@ module Streamly.Prelude

2020 -- * Construction and Deconstruction

2121 -- | Primitives to construct or inspect a stream.

2222 nil

23− , once

2423 , consM

2524 , (|:)

25+ , once

2626 , cons

2727 , (.:)

2828 , uncons

src/Streamly/Streams.hs+4−3

@@ -154,7 +154,8 @@ type Streaming = IsStream

154154nil :: IsStream t => t m a

155155nil = fromStream S.nil

156156

157−-- | Create a single element (singleton) stream from a monadic action.

157+-- | Create a singleton stream from a monadic action. Same as @m \`consM` nil@

158+-- but more efficient.

158159--

159160-- @

160161-- > toList $ once getLine

@@ -193,8 +194,8 @@ infixr 5 |:

193194

194195infixr 5 `cons`

195196

196−-- | Same as @consM . return@. Constructs a stream by adding a pure value at

197−-- the head of an existing stream. For example:

197+-- | Construct a stream by adding a pure value at the head of an existing

198+-- stream. Same as @consM . return@. For example:

198199--

199200-- @

200201-- > toList $ 1 \`cons` 2 \`cons` 3 \`cons` nil