On 15 February 2012 17:55, Aristid Breitkreuz wrote:

In the source file, the Haddock documentation is there, no idea why it doesn't show up.

Looks like it's an issue with getting the Haddock markup from another package, though I've usually had this work before... e.g. http://hackage.haskell.org/packages/archive/graphviz/2999.12.0.4/doc/html/Da...

Am 15.02.2012 04:00 schrieb "Doug McIlroy" :

...

Markus: "What about hoogle/hayoo and hackage?"

Antoine: "Do you have any links to examples that we should imitate?"

Hackage is notionally similar to the Java API documentation at http://www.oracle.com/technetwork/java/javase/documentation/ But Hackage "Documentation" pages typically only give syntax, while Java pages invariably summarize semantics.  This makes a world of difference. The quality of the summaries bespeaks a lot of editorial attention above and beyond culling annotations from source code.

Considerable care has been taken in describing the GHC library at http://www.haskell.org/ghc/docs/ but even there one can find absolute mystery entries like

http://www.haskell.org/ghc/docs/latest/html/libraries/haskell98-2.0.0.1/Loca...

Doug

...

It is hard to find one's way in this ecosystm. It needn't be, as Java illustrates. To my mind Java's great contribution to the world is its library index--light years ahead of typical "documentation" one finds at haskell.org, which lacks the guiding hand of a flesh-and-blood librarian. In this matter, it seems, industrial curation can achieve clarity more easily than open source.

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

_______________________________________________ Haskell-Cafe mailing list Haskell-Cafe@haskell.org http://www.haskell.org/mailman/listinfo/haskell-cafe

-- Ivan Lazar Miljenovic Ivan.Miljenovic@gmail.com http://IvanMiljenovic.wordpress.com