Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Testing predicates for documentation of Michelson contracts
Documentation
testDocBasic :: [DocTest] Source #
Base properties which should comply for all documentations.
Individual test predicates
testContractNameAtTop :: DocTest Source #
Check that contract documentation is wrapped with contractName
.
testNoGitInfo :: DocTest Source #
Check that contracts themselves do not set the git revision. It is supposed to be filled only in the executable.
testDocNotEmpty :: DocTest Source #
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.
testStorageIsDocumented :: DocTest Source #
Test whether storage documentation is included in the contract's documentation.
Re-exports
module Test.Cleveland.Doc.Common