Haddock comments in import list aren't treated correctly #220

New Issue

2019-02-19T02:26:19+01:00

sevanspowell commented

2019-02-19 02:26:19 +01:00

(Migrated from github.com)

Brittany reformats this:

module Some.Polling
  (
  -- * Types
    PollIntervalMicroseconds(PollIntervalMicroseconds)
  , PollPredicate(PollPredicate)
  , PollMaxAttempts(PollMaxAttempts)
  , PollingTimeoutError(PollingTimeoutError)
  , AsPollingTimeoutError(_PollingTimeoutError)
  -- * Polling
  , pollUntil
  , pollUntilTimeout
  )
where

to this:

module Some.Polling
  (
  -- * Types
    PollIntervalMicroseconds(PollIntervalMicroseconds)
  , PollPredicate(PollPredicate)
  , PollMaxAttempts(PollMaxAttempts)
  , PollingTimeoutError(PollingTimeoutError)
  , AsPollingTimeoutError
    ( _PollingTimeoutError
  -- * Polling
    )
  , pollUntil
  , pollUntilTimeout
  )
where

which Haddock won't accept:

error:
    parse error on input ‘-- * Polling’
   |
20 |   -- * Polling
   |   ^^^^^^^^^^^^

Brittany reformats this: ``` module Some.Polling ( -- * Types PollIntervalMicroseconds(PollIntervalMicroseconds) , PollPredicate(PollPredicate) , PollMaxAttempts(PollMaxAttempts) , PollingTimeoutError(PollingTimeoutError) , AsPollingTimeoutError(_PollingTimeoutError) -- * Polling , pollUntil , pollUntilTimeout ) where ``` to this: ``` module Some.Polling ( -- * Types PollIntervalMicroseconds(PollIntervalMicroseconds) , PollPredicate(PollPredicate) , PollMaxAttempts(PollMaxAttempts) , PollingTimeoutError(PollingTimeoutError) , AsPollingTimeoutError ( _PollingTimeoutError -- * Polling ) , pollUntil , pollUntilTimeout ) where ``` which Haddock won't accept: ``` error: parse error on input ‘-- * Polling’ | 20 | -- * Polling | ^^^^^^^^^^^^ ```

tfausak commented

2020-11-15 18:40:57 +01:00

(Migrated from github.com)

Fixed by 38cdd15221.

Fixed by 38cdd152218799b91993e6483903fd5618b7d6d9.

Sign in to join this conversation.

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: hexagoxel/brittany#220