Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aik099 committed Mar 3, 2024
1 parent 4878d81 commit 5cb2aa3
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@

PHPUnit-Compat is a compatibility layer for PHPUnit, that allows creating a test case/test suite classes, that will work across different PHPUnit versions.

Handled methods:
### Covered methods:

* `\PHPUnit\Framework\TestCase:onNotSuccessfulTest` via `\ConsoleHelpers\PHPUnitCompat\AbstractTestCase::onNotSuccessfulTestCompat`;
* `PHPUnit\Framework\TestSuite::run` via `\ConsoleHelpers\PHPUnitCompat\AbstractTestSuite::runCompat`;
* `\PHPUnit\Framework\TestSuite::tearDown` via `\ConsoleHelpers\PHPUnitCompat\AbstractTestSuite::tearDownCompat` (till PHPUnit 8.1.6; in PHPUnit 8.2.0 method was removed).

### Covered classes:

* `\PHPUnit\Framework\DataProviderTestSuite` via `\ConsoleHelpers\PHPUnitCompat\Framework\DataProviderTestSuite`;
* `\PHPUnit\Framework\TestResult` via `\ConsoleHelpers\PHPUnitCompat\Framework\TestResult`.

For assertion method compatibility please use https://github.com/Yoast/PHPUnit-Polyfills.

## Installation
Expand Down

0 comments on commit 5cb2aa3

Please sign in to comment.