Uh oh!
There was an error while loading. Please reload this page.
Docs: Remove the blank line between @param and @return in core docblocks - #13063
Docs: Remove the blank line between @param and @return in core docblocks#13063mukeshpanchal27 wants to merge 1 commit into
@param and @return in core docblocks#13063Conversation
…cblocks. The PHP inline documentation standards place `@return` immediately after the last `@param` tag, with no blank line separating them. This corrects 44 docblocks across 33 files in `src/wp-includes` that used a line break between the two tags. Note that this only applies to PHP. The JavaScript documentation standards do require a blank line before `@return`, so JSDoc blocks are left unchanged. Files under `src/wp-includes/blocks/`, the test suite, and bundled third-party libraries are out of scope for this change. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
Trac ticket: https://core.trac.wordpress.org/ticket/65818
The PHP inline documentation standards place
@returnimmediately after the last@paramtag, with no blank line between them:This corrects 44 docblocks across 33 files in
src/wp-includesthat used a line break between the two tags.Documentation-only; no functional change.
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.