Added throws annoation to log methods #51
Merged
Conversation
This file contains hidden or 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
Jean85
approved these changes
Nov 14, 2018
Member
Jean85
left a comment
Jean85
left a comment
There was a problem hiding this comment.
I'm 👍 on this but it requires an errata on the PSR
Contributor
Author
|
@Jean85 ping? Otherwise I close this because it's there since ages. |
Contributor
|
It's usual for throws annotations to be before return annotations? |
Contributor
|
See the current proposed PSR: https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#514-throws. |
Contributor
Author
|
@GrahamCampbell I don't mind, just let me know if I should change it and I change it. 😉 |
Contributor
|
Well, it's not up to me, but if it were, I'd change it. ;) |
Member
|
It's not up to me, but to the editor. |
Collaborator
|
I personally don't care much for Seems fine to me as is tho, if it helps the IDE folks, go for merge I would say. |
Seldaek
approved these changes
Jun 27, 2019
Contributor
Author
|
@Seldaek ping |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
PSR-3 clearly states that the
logmethod MUST throw aPsr\Log\InvalidArgumentExceptionif a level is given that is not known. However, the interface and the various base implementations are missing the corresponding@throwsannotation. Consequently IDEs do not know that such an exception could be thrown. This PR is meant to fix this circumstance.Please note that I refrained from adding any additional documentation to the annotation, simply because everything else is completely undocumented as well.