Skip to content

Commit db342d8

Browse files
authored
Readme: whitelist what forbidNotNormalizedType supports (#233)
1 parent a919257 commit db342d8

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -600,11 +600,18 @@ function example($unknown) {
600600
```
601601

602602
### forbidNotNormalizedType
603-
- Reports any PhpDoc or native type that is not normalized, which can be:
603+
- Reports PhpDoc or native type that is not normalized, which can be:
604604
- when child and parent appears in its union or intersection
605605
- when same type appears multiple times in its union or intersection
606606
- when DNF is not used
607607
- configurable by `checkDisjunctiveNormalForm`
608+
- supports:
609+
- parameter typehints & `@param` phpdoc
610+
- return typehint & `@return` phpdoc
611+
- property typehint & `@var` phpdoc
612+
- inline `@var` phpdoc
613+
- `@throws` phpdoc
614+
- multi-catch statements
608615
- Main motivation here is that PHPStan normalizes all types before analysis, so it is better to see it in codebase the same way PHPStan does
609616

610617
```php

0 commit comments

Comments
 (0)