Docs: Align @param tag columns in block editor docblocks - #13311
Open
mukeshpanchal27 wants to merge 1 commit into
Open
Docs: Align @param tag columns in block editor docblocks#13311mukeshpanchal27 wants to merge 1 commit into
@param tag columns in block editor docblocks#13311mukeshpanchal27 wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018AyprpqvcyKGrDdYmcnQnD
|
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. |
This was referenced Aug 29, 2026
Member
Author
|
GB changes PR WordPress/gutenberg#81903 |
t-hamano
reviewed
Aug 29, 2026
t-hamano
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the PR. This PR includes files that are automatically updated by syncing with Gutenberg. The files in src/wp-includes/blocks/ should not be updated.
Contributor
|
This needs to be fixed, similar to GutenbergPR. |
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.
Trac ticket: https://core.trac.wordpress.org/ticket/65818
The PHP inline documentation standards call for
@paramtags in a docblock to line up in columns — types, variable names, and descriptions each starting at the same offset — with wrapped descriptions indented to the description column:This corrects 58
@paramlines across 16 files in the block editor, block supports, andtheme.jsonclasses.Example
src/wp-admin/widgets-form-blocks.php— before:after:
Files changed (16)
src/wp-includes/blocks.phpsrc/wp-includes/blocks/accordion.phpsrc/wp-includes/blocks/heading.phpsrc/wp-includes/blocks/list.phpsrc/wp-includes/blocks/navigation-link.phpsrc/wp-includes/blocks/navigation.phpsrc/wp-includes/blocks/page-list.phpsrc/wp-includes/blocks/social-link.phpsrc/wp-includes/blocks/widget-group.phpsrc/wp-includes/block-supports/layout.phpsrc/wp-includes/block-supports/settings.phpsrc/wp-includes/block-template-utils.phpsrc/wp-includes/class-wp-theme-json.phpsrc/wp-includes/class-wp-theme-json-schema.phpsrc/wp-includes/style-engine/class-wp-style-engine-css-rules-store.phpsrc/wp-admin/widgets-form-blocks.phpPart of a series
The original work was a single branch touching 80 files. It is split by component so each can be reviewed and committed independently:
@paramtag columns in block editor docblocks #13311 — block editor (this PR)@paramtag columns in REST API docblocks #13312 — REST API@paramtag columns in upgrade, plugin, and theme docblocks #13313 — upgrade, plugins, and themes@paramtag columns in users and multisite docblocks #13314 — users and multisite@paramtag columns in post, comment, taxonomy, and media docblocks #13315 — posts, comments, taxonomy, and media@paramtag columns in administration docblocks #13316 — administration@paramtag columns in general core API docblocks #13317 — general core APIsThis is a whitespace-only change:
git diff -wagainsttrunkis empty, so there is no functional change and no change to any generated documentation output beyond the alignment itself.Use of AI Tools
AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5
Used for: Grouping a single large docblock alignment branch into per-component pull requests, verifying that the split is whitespace-only and that the seven branches together reproduce the original diff line for line, and drafting this description. I reviewed the alignment changes before submitting.