search

spl / dlist

Difference lists in Haskell
https://hackage.haskell.org/package/dlist
BSD 3-Clause "New" or "Revised" License
65 stars 15 forks source link

Please, link Haddocks to the readme.md #103

Closed Anton-Latukha closed 2 years ago

Anton-Latukha commented 2 years ago

I read through Haddocks & then went to articles that explain DList, as http://h2.jaguarpaw.co.uk/posts/demystifying-dlist/.

Then I added benchmarks to the comparison repo to see "real" results.

Only in the end I see that DList has a tutorial in the readme.md.

Also note that linked article is named "demystifying DList", which implied that DList was considered a mystery when the article was written. Mentioning good 3rd party articles in the docs also can be a cheap efficient way of providing info, if only just to give reassurance that 3rd party article is viable & may give additional angles if reader did not grokked the documentation.

Anton-Latukha commented 2 years ago

Oh, I'm stupid.

Hackage already does it.

It is me who skips the frontpage & directly looks at appropriate module docs.