Add a note about static analysis #235
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nyholm
reviewed
Jan 19, 2021
README.md
Outdated
| @@ -249,6 +249,9 @@ Overriding the following methods in your assertion class allows you to change th | |||
| * `protected static function reportInvalidArgument($message)` | |||
| * This method is called when an assertion fails, with the specified error message. Here you can throw your own exception, or log something. | |||
|
|
|||
| ## Static analysis support | |||
|
|
|||
| Where applicable assertion functions are annotated to support Psalms' [Assertion syntax](https://psalm.dev/docs/annotating_code/assertion_syntax/). A dedicated [PHPStan Plugin](https://github.com/phpstan/phpstan-webmozart-assert) is required for proper type support. | |||
There was a problem hiding this comment.
I like this. Two things:
- Write
Psalm's - Split this line after the word after 80 character length.
There was a problem hiding this comment.
Thanks, adjusted (not accurately on 80 chars.. hope thats ok) - have no editor at hand atm.
|
ping @Nyholm |
Nyholm
reviewed
Feb 28, 2021
This was referenced Mar 10, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.