I18N: Use /* */ block style for translator comments#12274
Conversation
Convert the remaining `// translators:` line comments to the `/* translators: */` block style used throughout core, for consistency with the documented i18n coding standards. Files under `wp-includes/blocks/` are intentionally excluded, as they are maintained in the Gutenberg plugin and need to be changed there first. See #65518.
|
Hi there! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making. More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook. Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook. If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook. The Developer Hub also documents the various coding standards that are followed:
Thank you, |
|
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. |
| __METHOD__, | ||
| sprintf( | ||
| // translators: %s is the name of any user-provided key | ||
| /* translators: %s is the name of any user-provided key */ |
There was a problem hiding this comment.
Make sure to add end period.
| /* translators: %s is the name of any user-provided key */ | |
| /* translators: %s is the name of any user-provided key. */ |
Trac ticket: https://core.trac.wordpress.org/ticket/65518
What
Converts the remaining
// translators:line comments in core to the/* translators: */block comment style that is used consistently throughoutwp-adminandwp-includes(2,636 block-style vs. 27 line-style before this change).Why
Per the ticket discussion, this is a coding-standards consistency change. To be clear about scope: the
// translators:style is still extracted correctly bywp i18n make-pot/xgettextwhen the comment sits directly above the gettext call, so this is not fixing broken extraction — it is aligning the few outliers with the documented block-comment convention.Scope
This PR covers the 8 core-authored files (14 occurrences):
wp-admin/site-health.phpwp-admin/includes/class-wp-site-health.phpwp-includes/abilities-api/class-wp-abilities-registry.phpwp-includes/abilities-api/class-wp-ability-categories-registry.phpwp-includes/class-wp-icons-registry.phpwp-includes/fonts/class-wp-font-collection.phpwp-includes/html-api/class-wp-html-processor.phpwp-includes/rest-api/endpoints/class-wp-rest-icons-controller.phpThe
// translators:comments inwp-includes/blocks/*.phpare intentionally excluded, as those files are maintained in the Gutenberg plugin and need to be changed there first (per @sabernhardt in comment:2, +1 @mukesh27 in comment:3).Notes
php -lpasses on all touched files.