haskell / haskell/stylish-haskell

stylish-haskell deletes Haddock export list documentation

Open
#466 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
1k
Forks
153
PR merge metrics
No merged PRs in 30d

Description

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
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.