Skip to content
This repository was archived by the owner on Jan 14, 2025. It is now read-only.

Update README.md #3

Merged
merged 1 commit into from
Apr 21, 2015
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

Support for discovering tests and test suites using reflection.

It follows the xUnit style where each class is a test suite, and each method
with the name prefix "test_" is a single text.
This package follows the xUnit style where each class is a test suite, and each
method with the name prefix `test_` is a single test.

Methods with names starting with "test_" are are run using test() function with
the corresponding name. If the class defines methods setUp() or tearDown(),
they are executed before / after each test correspondingly, even the test fails.
Methods with names starting with `test_` are run using the `test()` function with
the corresponding name. If the class defines methods `setUp()` or `tearDown()`,
they are executed before / after each test correspondingly, even if the test fails.

Methods with names starting with "solo_test_" are run using solo_test() function.
Methods with names starting with `solo_test_` are run using the `solo_test()` function.

Methods with names starting with "fail_" are expected to fail.
Methods with names starting with `fail_` are expected to fail.

Methods with names starting with "solo_fail_" are run using solo_test() function
Methods with names starting with `solo_fail_` are run using the `solo_test()` function
and expected to fail.

Method returning Future class instances are asynchronous, so tearDown() is
executed after the returned Future completes.
Method returning `Future` class instances are asynchronous, so `tearDown()` is
executed after the returned `Future` completes.

## Features and bugs

Expand Down