Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
staabm committed Dec 14, 2023
1 parent 2e56de8 commit 6a3b283
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,11 @@ function doFoo() {
## Supported todo formats

Every comment which matches the [supported pattern](https://github.com/staabm/phpstan-todo-by/blob/main/src/TodoByRule.php#L15) will be checked.
The supported dateformat is `YYYY-MM-DD`.
See [all supported examples](https://github.com/staabm/phpstan-todo-by/blob/main/tests/data/example.php) in the Testsuite.

A todo comment can also contain just of a date without any text, like `// TODO 2023-12-14`.
When a text is given after the date, this text will be picked up for the PHPStan error message.

The supported dateformat is `YYYY-MM-DD`. See [all supported examples](https://github.com/staabm/phpstan-todo-by/blob/main/tests/data/example.php) in the Testsuite.


## Installation
Expand Down

0 comments on commit 6a3b283

Please sign in to comment.