Conversation
Adds a description to the 30 Grunt tasks that were registered without one, so that every task is described in the output of `grunt --help`. Existing docblocks are kept. The `apply` alias is left unchanged because Grunt already describes it as an alias for the `patch` task. This is a documentation-only change. No task lists or task functions were changed. See #65858.
|
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. |
Adds a description to the 30 Grunt tasks in
Gruntfile.jsthat are registered without one, so that every task has a meaningful entry ingrunt --help.When
grunt.registerTask()is called without a description, Grunt falls back to a generic one:Custom task.for function tasks, orAlias for "…" tasks.listing the subtasks for alias tasks. On current trunk, 31 of the 49 registered tasks show one of these placeholders.Notes
registerTask()call.verify:build,verify:old-files,verify:source-maps,build:gutenberg) are kept, and each task's description summarizes its docblock.applyalias is left unchanged. Grunt already describes it asAlias for "patch" task., which is accurate.Runs QUnit tests.. Where a task has a notable option or requirement, it is mentioned:build: the--devoption.watch: thewatch:phpunittarget and the--phpunitoption.precommit:emoji: the GitHub CLI requirement.Testing Instructions
npm ci.trunk, runnpx grunt --helpand look at the Available tasks section. Tasks such asbuild,watch, andverify:old-filesshowCustom task., and tasks such asrtl,build:css, andprecommit:jsshow a generatedAlias for "…" tasks.list.npx grunt --helpagain. Every task defined inGruntfile.jsnow has a descriptive entry.applystill showsAlias for "patch" task..npx grunt jshint:gruntto confirm that the Gruntfile still lints cleanly.Evidence
Generic placeholder descriptions in the output of
npx grunt --help:Custom task.Alias for "…"apply, intentional)Before (trunk), excerpt
After (this branch), excerpt
Lint
Trac ticket: #65858
Use of AI Tools
grunt --helpoutput and linting locally.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.