From 43ad7c8e825057747ccf02049050b323878952a7 Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sat, 5 Aug 2017 11:56:24 +0200 Subject: documentation: fix rendering and internal references This is mainly cleanup after switching from Github-flavoured Markdown rendered by Github Pages, to standard Markdown rendered by MkDocs. Changed: - rephrase some section titles Fixed: - list rendering (items, sub-items)) - code rendering - quotes - dead links Removed: - extraneous navigational elements Signed-off-by: VirtualTam --- doc/md/Unit-tests.md | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) (limited to 'doc/md/Unit-tests.md') diff --git a/doc/md/Unit-tests.md b/doc/md/Unit-tests.md index 19838721..d200634f 100644 --- a/doc/md/Unit-tests.md +++ b/doc/md/Unit-tests.md @@ -3,8 +3,9 @@ The framework used is [PHPUnit](https://phpunit.de/); it can be installed with [Composer](https://getcomposer.org/), which is a dependency management tool. Regarding Composer, you can either use: -* a system-wide version, e.g. installed through your distro's package manager -* a local version, downloadable [here](https://getcomposer.org/download/) + +- a system-wide version, e.g. installed through your distro's package manager +- a local version, downloadable [here](https://getcomposer.org/download/) #### Sample usage @@ -118,18 +119,20 @@ Tests: 36, Assertions: 63, Errors: 1, Failures: 2. By default, PHPUnit will run all suitable tests found under the `tests` directory. Each test has 3 possible outcomes: -* `.` - success -* `F` - failure: the test was run but its results are invalid - * the code does not behave as expected - * dependencies to external elements: globals, session, cache... -* `E` - error: something went wrong and the tested code has crashed - * typos in the code, or in the test code - * dependencies to missing external elements + +- `.` - success +- `F` - failure: the test was run but its results are invalid + - the code does not behave as expected + - dependencies to external elements: globals, session, cache... +- `E` - error: something went wrong and the tested code has crashed + - typos in the code, or in the test code + - dependencies to missing external elements If Xdebug has been installed and activated, two coverage reports will be generated: -* a summary in the console -* a detailed HTML report with metrics for tested code - * to open it in a web browser: `firefox coverage/index.html &` + +- a summary in the console +- a detailed HTML report with metrics for tested code + - to open it in a web browser: `firefox coverage/index.html &` ### Executing specific tests -- cgit v1.2.3