Docs: Remove the blank line between @param and @return in test docblocks - #80
Closed
mukeshpanchal27 wants to merge 2 commits into
Closed
Docs: Remove the blank line between @param and @return in test docblocks#80mukeshpanchal27 wants to merge 2 commits into
@param and @return in test docblocks#80mukeshpanchal27 wants to merge 2 commits into
Conversation
…cblocks. The PHP inline documentation standards place `@return` immediately after the last `@param` tag, with no blank line separating them. This corrects 65 docblocks across 29 files in the PHPUnit test suite that used a line break between the two tags. This is a follow-up to the same correction made in `src/wp-includes`, kept as a separate change to keep each diff focused. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Owner
Author
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
1 participant
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
Follow-up to the same correction made in
src/wp-includes, kept as a separate PR so each diff stays focused.The PHP inline documentation standards place
@returnimmediately after the last@paramtag, with no blank line between them:This corrects 65 docblocks across 29 files in the PHPUnit test suite.
Where the changes land
tests/phpunit/includes/factory/tests/phpunit/tests/ajax/(privacy export/erase, crop image)tests/phpunit/tests/customize/tests/phpunit/tests/rest-api/block-supports,blocks,html-api,kses,image,post,privacy,term,functions)Verification
*blank comment line — no other content touched. 29 files changed, 0 insertions, 65 deletions.tests/: 0 remaining occurrences.php -lclean on all 29 changed files.Documentation-only; no test logic or assertions changed.
Related
Branched directly from
trunk, so it is independent of #79 (thesrc/wp-includescounterpart) and the two can land in either order.🤖 Generated with Claude Code