zaphar/ucg
1
0
Fork 0
mirror of https://github.com/zaphar/ucg.git synced 2025-07-22 18:19:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: Clarified the reference for assert statements.

Browse Source
This commit is contained in:
Jeremy Wall 2019-02-04 19:29:46 -06:00
parent 545ab62403
commit 3c91f48415
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docsite/site/content/reference/statements.md
View File

@ -46,7 +46,10 @@ ok field that is either true or false and a desc field that is a string. Assert
statements are noops except when executing `ucg test`. They give you a way to
assert certains properties about your data and can be used as a form of unit
testing for your configurations. It starts with the `assert` keyword followed
by a valid ucg expression.
by a valid ucg expression that resolves to a tuple with an `ok` field and a
`desc` field. The `ok` field must contain a boolean value. The `desc` field
must contain a description for this assertion. The `ok` field is `true` the
assert test succeeds. When it is `false` the assert test fails.
```
assert {