Skip to content

Commit

Permalink
Fix readme files about unit test scenarios
Browse files Browse the repository at this point in the history
  • Loading branch information
aquileia authored and cbeck88 committed May 19, 2014
1 parent a69ee6e commit 8136065
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion data/test/macros/readme.txt
@@ -1 +1 @@
This is place to put macros that are only usefull for running unit tests.
This is place to put macros that are only useful for running unit tests.
11 changes: 7 additions & 4 deletions data/test/scenarios/readme.txt
@@ -1,7 +1,10 @@
This is place to put any scenarios used by C++ unit tests.
This directory contains both the scenarios used by C++ unit tests and those which are
WML unit tests.

It is good idea to reuse same scenario file as much as possible and just inject wml to that.
Injection can be done creating config object with event code inside and then registering that
For the C++ unit tests, it is recommended to reuse the same scenario file as much as possible
and just inject WML into it.
Injection can be done by adding a config object containing event code and then registering that
manually for game_events.

It is also a good place to put scenarios which are WML unit tests.
WML unit tests are self-contained scenario files to test a specific area of WML. They can be
implemented with the GENERIC_UNIT_TEST macro.

0 comments on commit 8136065

Please sign in to comment.