hierarchical libraries documentation index
How about omitting the modules of the haskell98 package from the Haskell Hierarchical Libraries documentation index? They're not particularly hierarchical, and they're documented elsewhere. Having them in the doc index makes the docs look bad.
On Thu, 2004-07-29 at 11:31, Ross Paterson wrote:
How about omitting the modules of the haskell98 package from the Haskell Hierarchical Libraries documentation index? They're not particularly hierarchical, and they're documented elsewhere. Having them in the doc index makes the docs look bad.
Having a central place for documentation is rather nice, I use it as a reference all the time. If we don't want to put haddock documentation of the standard H98 libs here could we at least keep them and put a http link to where they are documented. That way if someone searches for a function name or some other part of the hierarchical libraries documentation makes reference to a standard function then the standard function will at least come up and at the top of the page it could have a link to where the function is documented. Personally I think it'd be nice to have haddock documentation for the H98 standard libs too, just as a reference. But I understand that would be rather a lot of work for someone. Duncan
On Thu, 29 Jul 2004 13:30:23 +0100, Duncan Coutts
On Thu, 2004-07-29 at 11:31, Ross Paterson wrote:
How about omitting the modules of the haskell98 package from the Haskell Hierarchical Libraries documentation index? They're not particularly hierarchical, and they're documented elsewhere. Having them in the doc index makes the docs look bad.
Having a central place for documentation is rather nice, I use it as a reference all the time. If we don't want to put haddock documentation of the standard H98 libs here could we at least keep them and put a http link to where they are documented.
That way if someone searches for a function name or some other part of the hierarchical libraries documentation makes reference to a standard function then the standard function will at least come up and at the top of the page it could have a link to where the function is documented.
Personally I think it'd be nice to have haddock documentation for the H98 standard libs too, just as a reference. But I understand that would be rather a lot of work for someone.
I think it would be nice to have the docs split up per-package. I.e. one page for haskell98, one for base, one for unix etc. Of course, there could be a complete page of everything too, but I find it's a pain to navigate it because it's so long... /Martin
On Thu, Jul 29, 2004 at 01:30:23PM +0100, Duncan Coutts wrote:
On Thu, 2004-07-29 at 11:31, Ross Paterson wrote:
How about omitting the modules of the haskell98 package from the Haskell Hierarchical Libraries documentation index? They're not particularly hierarchical, and they're documented elsewhere. Having them in the doc index makes the docs look bad.
Having a central place for documentation is rather nice, I use it as a reference all the time. If we don't want to put haddock documentation of the standard H98 libs here could we at least keep them and put a http link to where they are documented.
That way if someone searches for a function name or some other part of the hierarchical libraries documentation makes reference to a standard function then the standard function will at least come up and at the top of the page it could have a link to where the function is documented.
There should certainly be a link to the Revised Report and FFI Addendum. But if you look up unfoldr, say, you are referred to Data.List.unfoldr, where the function is indeed documented. So you're encouraged to import Data.List instead of the old generation List. No other part of the hierarchical libraries documentation refers to modules in the haskell98 package. The only functions defined in the haskell98 package are the obsolete versions of bracket and bracket_.
participants (3)
-
Duncan Coutts -
Martin Sjögren -
Ross Paterson