Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Some doc updates

Browse source
This commit is contained in:
Griatch 2017-10-28 22:51:47 +02:00
parent 65664bf523
commit a5a8d9dd57
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
evennia/utils/tests/test_evmenu.py
View file

@ -5,13 +5,15 @@ This sets up a testing parent for testing EvMenu trees. It is configured by subc
`TestEvMenu` class from this module and setting the class variables to point to the menu that should `TestEvMenu` class from this module and setting the class variables to point to the menu that should
be tested and how it should be called. be tested and how it should be called.
Without adding any further test methods, the tester will process all nodes of the menu, width first, Without adding any further test methods, the tester will process all nodes of the menu, depth first,
by stepping through all options for every node. It will check to make sure all are visited. It will by stepping through all options for every node. Optionally, it can check that all nodes are visited.
create a hierarchical list of node names that describes the tree structure. Easiest way to use this It will create a hierarchical list of node names that describes the tree structure. This can then be
is to run the test once to see how the structure looks. compared against a template to make sure the menu structure is sound. Easiest way to use this is to
run the test once to see how the structure looks.
The system also allows for testing the returns of each node as part of the parsing. To help debug The system also allows for testing the returns of each node as part of the parsing.
the menu, turn on `debug_output`, which will print the traversal process in detail.
To help debug the menu, turn on `debug_output`, which will print the traversal process in detail.
""" """