input-output-hk / input-output-hk/fs-sim
Haddocks fail to build on `ghc-8.10.7`
Open
- Dominant language
- Haskell
- Stars
- 2
- Forks
- 6
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 1
Description
Older versions of `haddock` can not handle `-- |` and `-- ^` inside type definitions
Contributor guide
Research direction
Reproduce the Haddock build on ghc-8.10.7 and inspect the type definitions containing `-- |` or `-- ^` comments. Determine which comment syntax older Haddock rejects, then verify that Haddock generation succeeds on ghc-8.10.7 without losing the intended documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100