diff options
author | Alec Theriault <alec.theriault@gmail.com> | 2018-01-12 16:45:48 -0500 |
---|---|---|
committer | Ben Gamari <ben@smart-cactus.org> | 2018-01-12 16:45:51 -0500 |
commit | e20046a0c4a552c5037797cf720fb34877bc2d21 (patch) | |
tree | ae4e5a12d4fa6dabbc4d535b458f297dd812e332 /HACKING.md | |
parent | b2f10d8981bebe44f1ab39e417818dfa2d50639d (diff) | |
download | haskell-e20046a0c4a552c5037797cf720fb34877bc2d21.tar.gz |
Support constructor Haddocks in more places
This adds support for adding Haddocks on individual non-record fields
of regular (and GADT) constructors. The following now parses just fine
with `-haddock` enabled:
data Foo
= Baz -- ^ doc on the `Baz` constructor
Int -- ^ doc on the `Int` field of `Baz`
String -- ^ doc on the `String` field of `Baz`
| Int -- ^ doc on the `Int` field of the `:*` constructor
:* -- ^ doc on the `:*` constructor
String -- ^ doc on the `String` field of the `:*`
constructor
| Boa -- ^ doc on the `Boa` record constructor
{ y :: () }
The change is backwards compatible: if there is only one doc and it
occurs
on the last field, it is lifted to apply to the whole constructor (as
before).
Reviewers: bgamari, alanz
Subscribers: rwbarton, thomie, mpickering, carter
Differential Revision: https://phabricator.haskell.org/D4292
Diffstat (limited to 'HACKING.md')
0 files changed, 0 insertions, 0 deletions