From dd7374633057e2e5eebe06e182b2ee435908671f Mon Sep 17 00:00:00 2001 From: Markus Staab Date: Thu, 14 Dec 2023 22:06:24 +0100 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f1faaa..adb2d80 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ function doFoo() { Every comment which matches the [supported pattern](https://github.com/staabm/phpstan-todo-by/blob/main/src/TodoByRule.php#L15) will be checked. -A todo comment can also contain just of a date without any text, like `// TODO 2023-12-14`. +A todo comment can also consist of just 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.