Skip to content

[#70] add check for docs content in Indigo's example contracts test

Pinto Pasquale requested to merge pasqu4le/#70-test-docs-content-indigo into master

Description

This keeps the existing testing for Indigo's examples and adds a check for each contract (Indigo-Lorentz couple) that verifies the content of documentation using their MarkDown representation.

NOTE: the new check does not compare ContractDocs directly because they do not have an Eq instance and it seems that in other documentation-related datatypes the Eq instance does not consider the textual content of documentation, but only its structure. Moreover the MarkDown representation is consistent, so it does not seem necessary to add a specific content-checking function.

Related issue(s)

Resolves #70 (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)

Merge request reports