google / google/ghc-source-gen

Support for generating haddock comments

Open
#91 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Haskell
Stars
101
Forks
33
PR merge metrics
No merged PRs in 30d

Description

Has there been any thought on adding support for module / declaration / parameter haddock comments? I'm trying to use this library to generate code that I would like to have nice haddock documentation on.

I tried my hand at implementing comments for modules at it seems as simple as filling out `hsmodHaddockModHeader` on `HsModule`, but as of 8.10 the `Outputable` [instance](https://downloads.haskell.org/~ghc/8.10.1/docs/html/libraries/ghc-8.10.1/GHC-Hs-Doc.html#t:HsDocString) on `HsDocString` wraps the output in double quotes which results in invalid Haskell.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.