Expanding Data.Foldable documentation with overview prose (pre-MR feedback requested)

Viktor Dukhovni ietf-dane at dukhovni.org
Thu Dec 24 21:22:38 UTC 2020


On Wed, Dec 23, 2020 at 06:19:51AM -0200, Viktor Dukhovni wrote:

> The draft version can be seen at:
> 
>   https://imrryr.org/~viktor/haskell/foldable-doc/Data-Foldable.html
> 
> along with a pre-formatted Data.Traversable (already merged some
> months back, but may not yet be easy to found in formatted form):
> 
>   https://imrryr.org/~viktor/haskell/foldable-doc/Data-Traversable.html
> 
> Any feedback appreciated... Is this roughly ready for an MR, or are there
> any changes that are needed first and best discussed on the list rather
> than via Gitlab?

I've integrated the suggestions posted so far, and added sections that
list all the strict and all the lazy functions together describing
briefly their common features.

If the overall approach is sound, it might perhaps now make sense to add
some brief text also in each function synopsis that classifies it as
strict recursive, lazy corecursive, or some hybrid.  But perhaps just
having that level of detail at the bottom is sufficient?

-- 
	Viktor.


More information about the Libraries mailing list