Skip to content

[#152] Documentation for ADT constructors & fields

Maxim Koltsov requested to merge maksbotan/#152-describe-fields-in-autodoc into master

Description

Problem: it is not always clear what constructors and/or fields of ADTs
used in contract mean, but there is now way to document them except of
using `typeDocMdDescription`, which is not chcked by the compiler.

Solution: add type-level descriptions for constructors and fields.
Demand that those descriptions are attached only to existing
constructors and fields, via a type family.

Related issue(s)

Resolves #152 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Maxim Koltsov

Merge request reports