Wanted: documentation for STM
Could someone who's used the STM subsystem submit a haddock documentation patch. Looking here: http://www.haskell.org/ghc/docs/latest/html/libraries/stm/Control-Concurrent... is embarrassing. -- Don
Clicking on any of the names takes you to the documentation for GHC.Conc, and each function seems reasonably documented there. Is Haddock able to show the documentation of these re-exported functions? Spencer Janssen On Dec 11, 2006, at 12:26 AM, Donald Bruce Stewart wrote:
Could someone who's used the STM subsystem submit a haddock documentation patch. Looking here:
http://www.haskell.org/ghc/docs/latest/html/libraries/stm/ Control-Concurrent-STM-TVar.html
is embarrassing.
-- Don _______________________________________________ Libraries mailing list Libraries@haskell.org http://www.haskell.org/mailman/listinfo/libraries
Spencer Janssen wrote:
Clicking on any of the names takes you to the documentation for GHC.Conc, and each function seems reasonably documented there. Is Haddock able to show the documentation of these re-exported functions?
The problem is that Haddock doesn't store all the documentation in the .haddock file for a package, so it can't propagate documentation for re-exported identifiers across package boundaries. Including all the documentation in the .haddock file would bloat the file quite a bit, I think. However, maybe we could export the documentation on a module-by-module basis, selected by an option in the module source. We should at least improve the presentation for identifiers that don't have documentation becuase they are re-exported from another package. Cheers, Simon
On 12/11/06, Simon Marlow
Spencer Janssen wrote:
Clicking on any of the names takes you to the documentation for GHC.Conc, and each function seems reasonably documented there. Is Haddock able to show the documentation of these re-exported functions?
The problem is that Haddock doesn't store all the documentation in the .haddock file for a package, so it can't propagate documentation for re-exported identifiers across package boundaries. Including all the documentation in the .haddock file would bloat the file quite a bit, I think.
However, maybe we could export the documentation on a module-by-module basis, selected by an option in the module source. We should at least improve the presentation for identifiers that don't have documentation becuase they are re-exported from another package.
Maybe you could make haddock record the documentation for modules that are hidden (perhaps only if their identifiers aren't re-exported anywhere else in the same package)?
dons:
Could someone who's used the STM subsystem submit a haddock documentation patch. Looking here:
http://www.haskell.org/ghc/docs/latest/html/libraries/stm/Control-Concurrent...
is embarrassing.
Ah, looks like haddock isn't propagating the haddocks out of GHC.Conc, http://www.haskell.org/ghc/docs/latest/html/libraries/base/GHC-Conc.html#v%3... What's the best way to fix this? -- Don
participants (4)
-
dons＠cse.unsw.edu.au -
Samuel Bronson -
Simon Marlow -
Spencer Janssen