Make WordPress Core

Opened 46 hours ago

Last modified 16 hours ago

#65858 new defect (bug)

Add descriptions for all registered Grunt tasks

Reported by: desrosj Owned by:
Priority: normal Milestone: Awaiting Review
Component: Build/Test Tools Version:
Severity: normal Keywords: good-first-bug has-patch
Cc: Focuses:

Description

There are currently 46 Grunt tasks registered in the Gruntfile.js. However, only 15 have a description defined and three others have a meaningful docblock.

Every registered task should at a minimum have a description defined as this is surfaced through grunt --help. But ideally every task also has a preceding docblock with additional details and ticket references for helpful context.

Change History (2)

This ticket was mentioned in PR #13024 on WordPress/wordpress-develop by @irozum.


37 hours ago
#1

  • Keywords has-patch added

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.

## 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.

@afercia commented on PR #13024:


16 hours ago
#2

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.

Note: See TracTickets for help on using tickets.