Idea to allow people to comment on Haskell docs
simonpj at microsoft.com
Fri Jan 20 03:53:00 EST 2006
I think it looks great! Just the job, thank you.
Did you modify the Haddock documentation too?
One thing to think about is what happens as the code evolves. When you
re-generate the Haddock docs, what happens? Since the links are done by
name (I think) it's probably not bad: you get links to the existing wiki
entries so long as the name of the function doesn't change. If a
function is deleted, I guess there'll be an orphan wiki entry, but
that's probably ok. Worth documenting this in the Haddock docs.
Adding source code links would complete the picture.
| -----Original Message-----
| From: Duncan Coutts [mailto:duncan.coutts at worc.ox.ac.uk]
| Sent: 19 January 2006 21:55
| To: Simon Peyton-Jones
| Cc: Haskell Libraries
| Subject: RE: Idea to allow people to comment on Haskell docs
| On Wed, 2006-01-18 at 09:01 +0000, Simon Peyton-Jones wrote:
| > It looks great! But I'd never have found the link if you hadn't
| > me at it.
| > Rather than "Wiki" say "User comments".
| > And I think the per-entry [User comment] link is essential.
| > people are going to be looking at a particular thing. For example,
| > is where I'd look for the link for svgRenderFromString.
| So take another look at these example pages:
| For the per-entry links, to conserve space I've just said [Comments]
| rather than [User Comments] and used a smaller font. These cosmetic
| things are easy to change if anyone complains.
| I've sent the haddock patches that implement this stuff to Simon
| so if people are generally favourable of this iteration of the patch
| perhaps he'd like to apply it. :-) I hope I've done the changes in
| a way that it should be straightforward to add source code links too
| if/when haddock is taught how to find the original source file for
| So, opinions?
More information about the Libraries