Ticket #24 (closed enhancement: fixed)

Opened 6 years ago

Last modified 5 years ago

Do something better about re-exported symbols from another package

Reported by: waern Owned by:
Priority: critical Milestone:
Version: Keywords:
Cc: jpm@…

Description

Do something better about re-exported symbols from another package.

Change History

Changed 6 years ago by anonymous

  • type changed from defect to enhancement

Changed 6 years ago by waern

To be able to display proper documentation for symbols from other packages, we need to store declarations in the .haddock files. We are currently waiting for GHC to provide Binary instances for declarations.

Changed 6 years ago by anonymous

  • cc jpm@… added

Changed 6 years ago by waern

  • priority changed from minor to major

Changed 6 years ago by waern

We might not need to store anything in the .haddock files if we can reconstruct all declarations from the TyThings available in the .hi files. We already convert instances using a conversion function toHsType :: Type -> HsType Name. We could try to write a conversation function toHsDecl :: TyThing -> HsDecl Name.

The downside of this approach is that we loose the original declaration style. For example, we don't know if a data type was declared using GADT-style syntax (with a 'where' clause), or normal style.

Changed 5 years ago by waern

  • priority changed from major to critical

Changed 5 years ago by waern

  • version 0.x deleted

Thanks to Isaac Dupree and his Summer of Code project, this is now implemented. We are able to generate documentation of the same level of detail for re-exported symbols as we do normally (modulo syntactic differences).

Changed 5 years ago by waern

  • status changed from new to closed
  • resolution set to fixed
Note: See TracTickets for help on using tickets.