From 8136065f75e0836d4219449729466cc2f0afb6bb Mon Sep 17 00:00:00 2001 From: aquileia Date: Mon, 19 May 2014 21:02:53 +0200 Subject: [PATCH] Fix readme files about unit test scenarios --- data/test/macros/readme.txt | 2 +- data/test/scenarios/readme.txt | 11 +++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/data/test/macros/readme.txt b/data/test/macros/readme.txt index 4db46c55ff31..c990511e7895 100644 --- a/data/test/macros/readme.txt +++ b/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. diff --git a/data/test/scenarios/readme.txt b/data/test/scenarios/readme.txt index 7ef6667d9328..5b06e7855e5d 100644 --- a/data/test/scenarios/readme.txt +++ b/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.