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
@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.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
Of the 46 tasks registered in
Gruntfile.jsviagrunt.registerTask(), only 15 had adescriptionargument and 3 more had an explanatory docblock/comment above them without one. Neither a missing description nor a docblock-only comment shows up ingrunt --help, which surfaces only thedescriptionargument passed toregisterTask().This adds a one-line
descriptionto the remaining 31 tasks (the 28 with neither, plus the 3 with docblock-only comments), so every registered task is now discoverable viagrunt --help. No task behavior, task lists, or task functions were changed — this is a documentation-only diff.Verified with
grunt --helpthat all 46 tasks now list a description,jshint:gruntstill lints the file cleanly, andnpm run build:devstill builds successfully against the modifiedGruntfile.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.