assertion section

[ukos-git]

currently, the assertion function documentation is done in assertion.rst using the assertion group integration from doxygen documented code.

The example section introduces use-case scenarios of the utf and also of introduces different assertion types. See for example the introduction of variable comparison or the test of waves.

To further improve documentation, the assertions section should contain more code and the examples that are primarily used to introduce assertions should be moved to the assertions main page.

The assertion definitions should then be grouped according with their CHECK, WARN and REQUIRE methods in blocks like this.

• Testing and Comparing Waves Document how to use the flags CHECK variant with documentation WARN variant ** REQUIRE variant
• Comparing Variables Document why a simple a == b is not enough here etc. CHECK variant WARN variant ** REQUIRE variant

...

[t-b]

We can also use doxygen groups for that. We use these in MIES for the background functions. The commands are @ingroup and @defgroup. And it is not that ugly, see https://alleninstitute.github.io/MIES/group/group___background_functions.html.

[ukos-git]

Groups would be the right way like in the test wave flags section for minorType and mayorType. Together with a decent explanation.