Various documentation improvements#82
Various documentation improvements#82chessai merged 1 commit intohaskell-streaming:masterfrom jhrcek:haddockFixes
Conversation
| > intercalates :: Stream f m () -> Stream (Stream f m) m r -> Stream f m r | ||
| > unzips :: Stream (Compose f g) m r -> Stream f (Stream g m) r | ||
| > separate :: Stream (Sum f g) m r -> Stream f (Stream g) m r -- cp. partitionEithers | ||
| > separate :: Stream (Sum f g) m r -> Stream f (Stream g m) r -- cp. partitionEithers |
There was a problem hiding this comment.
misplaced paren. Stream takes 3 type params, not 4..
| > mapsPost id = id | ||
| > mapsPost f . mapsPost g = mapsPost (f . g) | ||
| > mapsPost f = mapsPost f | ||
| > mapsPost f = maps f |
There was a problem hiding this comment.
This identity was useless. The original intention was probably this, right?
|
|
||
| Note that it also has the effect of 'Data.Maybe.catMaybes', 'Data.Either.rights' | ||
| 'map snd' and such-like operations. | ||
| @map snd@ and such-like operations. |
There was a problem hiding this comment.
Haddock can't link expressions like this, so using inline code block instead.
|
|
||
| -} | ||
|
|
||
| data Maybe' a = Just' a | Nothing' |
There was a problem hiding this comment.
Had to move this below the definition of scanned, otherwise haddock doesn't associate the documentation with the scanned function.
| {-# INLINABLE scanned #-} | ||
|
|
||
|
|
||
| {-| Streams the number of seconds from the beginning of action |
There was a problem hiding this comment.
This seems like doc comment for a function that has been removed some time ago. I deleted it because it gets merged with the documentation of the following function and is very confusing.
| "wit" :> () | ||
|
|
||
| >>> S.stdoutLn $ S.take 3 $ S.readFile "stream.hs" | ||
| >>> S.readFile "stream.hs" (S.stdoutLn . S.take 3) |
| constant factor that will be completely dwarfed when any IO is at issue. | ||
|
|
||
| But 'store' / 'copy' is /much/ more powerful, as you can see by reflecting on | ||
| But 'store' \/ 'copy' is /much/ more powerful, as you can see by reflecting on |
There was a problem hiding this comment.
Need to escape the slash to avoid interaction with the "italics" markup on the same line.
|
Sorry. This all looks great! Thanks. |
2 participants
Kudos! The haddocks for this library are superior to what's commonly available on hackage.
While reading the docs and playing with the examples I found various minor mistakes that I'm fixing in this PR. I'll probably submit more fixes in the future if you like it.