Ticket #54 (new enhancement)

Opened 6 years ago

Last modified 3 years ago

how to handle packages with add-on instances?

Reported by: claus Owned by:
Priority: minor Milestone:
Version: Keywords:
Cc: pho@…

Description

currently, haddock records instances with their class and their data type.

But what if I have a package that adds instances for classes and data types from other packages? In principle, haddock/cabal should update the existing pages, but I don't think they do, so my instances remain undocumented.

Alternative: store instances in separate xml file, have haddock pages for data/class extract and present the relevant instances from that xml file. That way, only the instances data base file needs to be updated, the other pages always present the latest state.

It might also be useful to present instances in the modules that define and reexport them, to document where instances are coming from and what instances will leak into your code by importing a module. This should probably be separate from the main module doc page hierarchy, in a separate instance import/export relation view.

Change History

Changed 6 years ago by ross

  • type changed from defect to enhancement

Changed 6 years ago by ross

  • priority changed from major to minor

Changed 3 years ago by PHO

  • cc pho@… added
Note: See TracTickets for help on using tickets.