Skip array parameter block content from main description#26
Merged
Conversation
WordPress array parameter documentation uses { } blocks after @param:
@param array $args {
Description of array members.
@type string $name Name.
}
Lines inside this block (except @type tags) were being added to the
main hook description, causing "Term arguments." and "}" to appear
in the wrong place.
This fix tracks when we're inside such a block and skips non-tag lines.
2 tasks
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
WordPress array parameter documentation uses
{ }blocks after@param:Lines inside this block (except
@typetags) were being added to the main hook description, causing "Term arguments." and}to appear in the wrong place.This fix tracks when we're inside such a block and skips non-tag lines.
Before
After
See multiple_type_tags_hook for a live example.
Test plan
vendor/bin/phpunit- all 48 tests passvendor/bin/phpcs- no style violations