chore: implement stricter PHPDoc types #3010
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
|
Code Climate has analyzed commit e250141 and detected 0 issues on this pull request. View more on Code Climate. |
justlevine
added
status: in review
jasonbahl
approved these changes
Jan 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
What does this implement/fix? Explain your changes.
This PR adds stricter PHPDoc type definitions where possible and obvious.
More specifically:
callabletypes.mixedtype with a more specific typedef wherever possible.arraytypes traversable definitions wherever possible.No actual code has been changed. If 3rd-party code is using an incorrect type, their IDE/linter will now show the type-smells (versus waiting for unexpected behavior and hoping the logs catch something).
Does this close any currently open issues?
Any relevant logs, error output, GraphiQL screenshots, etc?
Any other comments?
💭The stricter we can get our doc-blocks the easier itl be when work begins on V2 💭
Where has this been tested?
Operating System: Ubuntu 20.04 (wsl2 + devilbox + php 8.1.15)
WordPress Version: 6.4.2