stylish-haskell deletes Haddock export list documentation

[dcoutts]

Best explained by example.

Given this bit of module export list:

    -- * Table handles
  , TableHandle
  , TableConfig (..)
  , new
  , close
    -- ** Resource management
    -- $resource-management

    -- * Table queries and updates
    -- ** Queries
  , lookups
  , LookupResult (..)

stylish-haskell wants to delete these three lines entirely

    -- ** Resource management
    -- $resource-management

This is obviously wrong. That section heading and corresponding bit of documentation is important. It must not be deleted.

But also, the trailing blank line there is necessary syntax. Without it, haddock will merge the subsequent section in, rather than giving it its own section name "Table queries and updates".

$ stylish-haskell --version
stylish-haskell 0.14.5.0

[dcoutts]

Another example. It looks like it accepts such sections at the end of the export list like:

    -- * Utility types
  , IOLike
    -- * Resource management
    -- $resource-management
  ) where

however if one uses more than one section at the end, then it wants to delete all but the final one. So an example like this gets mangled:

    -- * Utility types
  , IOLike
    -- * Concurrency
    -- $concurrency

    -- * Resource management
    -- $resource-management
  ) where

It'll again delete the concurrency section.