Skip to content

Commit d67fa46

Browse files
committed
extend README
1 parent 35cf80c commit d67fa46

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ This package provides the following rules for use with [`phpstan/phpstan`](https
3333

3434
### `ImmutableObjectRule`
3535

36-
This rule reports an error when a class tagged as immutable is mutable. This can be used for example to ensure that value objects are always immutable.
36+
This rule reports an error when a class or class property tagged as immutable is mutable. This can be used for example to ensure that value objects are always immutable.
3737

38-
:bulb: Classes can be tagged as immutable by adding the annotation `@psalm-immutable` or `@immutable` to the class phpdoc.
38+
:bulb: Classes or properties can be tagged as immutable by adding the annotation `@psalm-immutable` or `@immutable` to the phpdoc.
39+
40+
:bulb: The immutability rule also asserts that immutable properties are not mutated in child classes
3941

4042
## License
4143

0 commit comments

Comments
 (0)