Skip to content

Build/Test Tools: Add descriptions for all registered Grunt tasks - #13024

Open
irozum wants to merge 1 commit into
WordPress:trunkfrom
irozum:fix/65858-grunt-task-descriptions
Open

Build/Test Tools: Add descriptions for all registered Grunt tasks#13024
irozum wants to merge 1 commit into
WordPress:trunkfrom
irozum:fix/65858-grunt-task-descriptions

Conversation

@irozum

@irozum irozum commented Aug 12, 2026

Copy link
Copy Markdown

Of the 46 tasks registered in Gruntfile.js via grunt.registerTask(), only 15 had a description argument and 3 more had an explanatory docblock/comment above them without one. Neither a missing description nor a docblock-only comment shows up in grunt --help, which surfaces only the description argument passed to registerTask().

This adds a one-line description to the remaining 31 tasks (the 28 with neither, plus the 3 with docblock-only comments), so every registered task is now discoverable via grunt --help. No task behavior, task lists, or task functions were changed — this is a documentation-only diff.

Verified with grunt --help that all 46 tasks now list a description, jshint:grunt still lints the file cleanly, and npm run build:dev still builds successfully against the modified Gruntfile.js.

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

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Sonnet 5
Used for: Implementation and PR description. Reviewed by irozum.


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.

@github-actions

github-actions Bot commented Aug 12, 2026

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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @rozumiq@gmail.com.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

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

Props afercia.

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.

@afercia

afercia commented Aug 13, 2026

Copy link
Copy Markdown
Member

Nice, I quickly tested it and all tasks have a description in the 'Avaiable tasks' of the Grunt help.
I didn;t go in depth to check the actual descriptions content but overall it seems a valuable change to me.

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.

2 participants