Test.Cleveland.Doc.Michelson

Testing predicates for documentation of Michelson contracts

Documentation

testDocBasic :: [DocTest]

Base properties which should comply for all documentations.

Individual test predicates

testContractNameAtTop :: DocTest

Check that contract documentation is wrapped with contractName.

testNoGitInfo :: DocTest

Check that contracts themselves do not set the git revision. It is supposed to be filled only in the executable.

testDocNotEmpty :: DocTest

Check that there is at least one non-grouping doc item.

If there is no such, rendered documentation will be empty which signals about most of the documentation pieces being lost.

testNoAdjacentDescriptions :: DocTest

Check that no group contains two DDescription items.

Normally such behaviour is allowed and can be exploited, but often it is not and multiple descriptions appearence under the same group signals about missing grouping wrapper (e.g. use of caseT instead of entryCase).

testStorageIsDocumented :: DocTest

Test whether storage documentation is included in the contract's documentation.

Re-exports

module Test.Cleveland.Doc.Common