Skip to content

[#104] Show sample values in autodoc

Moremi Vannak requested to merge rinn7e/#104-sample-val-autodoc into master

Description

Problem: Documentation produced by our autodoc engine shows argument type of each entrypoint which is good, but people who use vanilla Michelson may have difficulties constructing a value of that type. In order to make their life a bit easier we can provide some sample value of that type.

Solution: Generate sample values from entrypoint type. Add a way to modify those same values value with desire values.

Related issue(s)

Resolves #104 (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 Moremi Vannak

Merge request reports