Skip to content

haddock regression: formatting re-exported module

Summary

Two issues for a module which re-exports module.

  1. haddock for GHC 9.12: the order of functions and types are automatically sorted. The original ordering should be kept.

  2. haddock for GHC 9.8 or later: mark up such as "-- *" are ignored. (Except haddock for GHC 9.12, the original ordering is kept correctly.)

haddock for GHC 9.6 does not have these two issues.

Steps to reproduce

Use haddock to a module which re-exports module and look at the result. An example module is: https://github.com/kazu-yamamoto/network-control/blob/main/Network/Control.hs

Expected behavior

  • The original ordering should be kept.
  • The markups should be correctly handled.

Environment

  • GHC version used: GHC 9.6 - GHC 9.12

Optional:

  • Operating System:
  • System Architecture:
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information