Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Automatic Tested Code Examples

Within this document all code examples are automatically tested.

Test result banners

Each code example has a banner nearby which indicates the current testing status of the code. If you click one of these banners you will jump directly into a specific test report.

The following banners indicate that the code is tested ok:

BannerMeaning
okOk
okOk (with warnings)
fail_okFails intentionally

The following banners occur if a test is still marked as todo but is ok already. This can be corrected by changing the documentation.

BannerMeaning
not_todoMarked as todo but is ok
not_todo_failMarked as todo but fails intentionally

If you see one of the following banners, we did something wrong. Either the example may be wrong or the µcad interpreter might have a bug.

BannerMeaning
failFails with errors
fail_wrongFails with wrong errors or warnings
ok_failIs ok but was meant to fail
parse_failFails early while parsing

The following banners occur if tests are marked as todo and so are not running successful.

BannerMeaning
todoWork in progress
todo_failWork in progress (should fail)

Test list

See this section for a list of tests within this document.