search

haskell-streaming / streaming

An optimized general monad transformer for streaming applications, with a simple prelude of functions
BSD 3-Clause "New" or "Revised" License
160 stars 30 forks source link

Module documentation just ends mid-sentence #117

Open mauke opened 1 year ago

mauke commented 1 year ago

https://hackage.haskell.org/package/streaming-0.2.3.1/docs/Streaming.html#v:untilJust

untilJust :: (Monad m, Applicative f) => m (Maybe r) -> Stream f m r

Repeat a

chessai commented 1 year ago

Thanks for pointing this out. This should read something more like (wording could need work)

Repeat a monadic action until it returns a 'Just' value.

along with an example.

I noticed that untilLeft and untilRight don't have docs at all.