lennart
commented
9 years ago From what I read in the lurk group, this is answered partially:
Mapping over patterns is definitely something to into the "conceptual" chapter to be created, while Reference should stay function listing only.
Regarding auto-generation of documentation, this would really be something nice-to-have to ease the process of documenting new functions when a new release is coming up (i.e. document the functions while coding within the source code and have the docs updated as soon as it is published on cabal) However, I am still not that good at working with haddock, and didn't have the time to get something like a "push hook" which github supports to be called whenever the cabal package is updated…and haddock does not read or write markdown…
A general question for me would be, whether the Reference chapter is going to be a list of functions only, or if it is going to be a mix between conceptual functionality (e.g. like Mapping over patterns) and plain function description.
If we still plan on autogenerating the docs from source code at some point, it might be wise to add this distinction within the reference chapter at this point already.