Skip to content

Improve docs to avoid Risky test warnings #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aik099 merged 2 commits into from
Jun 27, 2025
Merged

Improve docs to avoid Risky test warnings #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6dbfe0
Improve docs to avoid Risky test warnings
aik099 Jun 26, 2025
4a02785
Improve formatting
aik099 Jun 26, 2025
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: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,21 @@ assertThat($result === true);
assertThat(true, is(true));
```

:warning: **NOTE:** the global proxy-functions aren't autoloaded by default, so you will need to load them first:

```php
\Hamcrest\Util::registerGlobalFunctions();
```
> [!NOTE]
> To prevent tests from being marked as Risky (the `This test did not perform any assertions` message)
> add this code to your test case `tearDown` method:
>
> ```php
> $this->addToAssertionCount(\Hamcrest\MatcherAssert::getCount());
> \Hamcrest\MatcherAssert::resetCount();
> ```

> [!WARNING]
> the global proxy-functions aren't autoloaded by default, so you will need to load them first:
>
> ```php
> \Hamcrest\Util::registerGlobalFunctions();
> ```

For brevity, all of the examples below use the proxy-functions.

Expand Down