Skip to content

[#39] Tests on autodoc

Konstantin Ivanov requested to merge martoon/#39-autodoc-tests into master

Description

Problem: it's too easy to break generated documentation entirely and it's often hard to notice that.

Solution: test various simple predicates on documentation like "all entrypoints have description".

AFAIU this covers mostly all breakages which we had at this moment, except the one when part of doc got lost after the corresponding code being moved to storage. The latter I want to resolve separately (see #49) because it's not yet entirely clear which way to ensure this will be the best one, need to collect more data about accidents.

Recommended review order of the main commit:

  • Michelson.Doc.Test
  • Everything else.

Related issue(s)

Resolves #39 (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 the changelog if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Konstantin Ivanov

Merge request reports