Skip to content

Docs: Remove the blank line between @param and @return in test docblocks - #13119

Open
mukeshpanchal27 wants to merge 2 commits into
WordPress:trunkfrom
mukeshpanchal27:docs/param-return-blank-line-tests
Open

Docs: Remove the blank line between @param and @return in test docblocks#13119
mukeshpanchal27 wants to merge 2 commits into
WordPress:trunkfrom
mukeshpanchal27:docs/param-return-blank-line-tests

Conversation

@mukeshpanchal27

Copy link
Copy Markdown
Member

Trac ticket: https://core.trac.wordpress.org/ticket/65818

Follow-up to #13063 in which it covers core file changes.

The PHP inline documentation standards place @return immediately after the last @param tag, with no blank line between them:

/**
 * Summary.
 *
 * @param string $var Description.
 * @return string Description.
 */

This corrects 65 docblocks across 29 files in the PHPUnit test suite.

Documentation-only; no functional change in tests.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5
Used for: I found a few occurrences myself, and Claude helped me identify the remaining ones and draft the PR.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…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>
@mukeshpanchal27 mukeshpanchal27 self-assigned this Aug 18, 2026
@mukeshpanchal27
mukeshpanchal27 marked this pull request as ready for review August 18, 2026 03:24
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props mukesh27.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant