search

haskell-streaming / streaming-bytestring

effectful sequences of bytes; an alternative no-lazy-io implementation of Data.ByteString.Lazy
BSD 3-Clause "New" or "Revised" License
16 stars 11 forks source link

Documentation Overhaul #27

Closed fosskers closed 3 years ago

fosskers commented 3 years ago

The streaming ecosystem is wonderful, but its public-facing documentation contains much content from its early days of experimentation. These explanations tend to be verbose and lack practical examples.

This PR reworks this library's README and other relevant documentation to be more user friendly.

Docstring coverage is now also 100%.

fosskers commented 3 years ago

Backticks do work to link symbols in Haddock.

vdukhovni commented 3 years ago

Backticks do work to link symbols in Haddock.

I did not know that, I've only seen single-quotes for that. Thanks for the note. I guess you can use whichever you prefer then, sorry about asking for these to be changed...

fosskers commented 3 years ago

No prob! I've using backticks for years so I was totally on autopilot when I added them all here. Pushing all your other suggestions up now...