Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ondrejmirtes committed Sep 4, 2020
1 parent 399481e commit 46413ec
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@

* [PHPStan](https://phpstan.org/)

This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as `@deprecated`.

In case you don't own the code which you want to be considered deprecated, use [PHPStan Stub Files](https://phpstan.org/user-guide/stub-files) to declare deprecations for vendor files like
```
/** @deprecated */
class ThirdPartyClass {}
```


## Installation

To use this extension, require it in [Composer](https://getcomposer.org/):
Expand All @@ -35,3 +26,13 @@ includes:
- vendor/phpstan/phpstan-deprecation-rules/rules.neon
```
</details>

## Deprecating code you don't own

This extension emits deprecation warnings on code, which uses properties/functions/methods/classes which are annotated as `@deprecated`.

In case you don't own the code which you want to be considered deprecated, use [PHPStan Stub Files](https://phpstan.org/user-guide/stub-files) to declare deprecations for vendor files like:
```
/** @deprecated */
class ThirdPartyClass {}
```

0 comments on commit 46413ec

Please sign in to comment.