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
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.
Summary
This pull request updates class constructor docblocks to accurately reflect that
$labelcan be either anarrayor astring. This change aims to address issues with code quality tools likephpstanthat arise due to the current incorrect specification of$labelas a string only. Fixes #867Background
Each constructor within the project has a
$labelparameter, which, according to the current docblocks, accepts only a string. This has been identified as incorrect since$labelcan also be an array. The mismatch between the implementation and the documentation causes tools likephpstanto report errors, potentially affecting code quality assurance processes.Changes
$labelcan be either astringor anarray.Testing
phpstanon a project that utilizeswordpress-fieldmanager.arrayfor$label, to simulate the scenario that previously led to errors.phpstanto ensure that it no longer reports errors regarding the type of$label.Additional Notes
This change is categorized as an enhancement rather than a bug fix, as it primarily aims to improve compatibility with code quality tools without altering the functionality of the existing codebase.
References
arrayor astringfor$label#867