Skip to content

chore(lint): resolve JSDoc warnings from wp-scripts 36 - #194

Merged
kraftbj merged 1 commit into
trunkfrom
chore/jsdoc-lint-warnings
Oct 20, 2026
Merged

kraftbj merged 1 commit into
trunkfrom
chore/jsdoc-lint-warnings

Conversation

@kraftbj

@kraftbj kraftbj commented Oct 20, 2026

Copy link
Copy Markdown
Collaborator

Clears the 31 lint warnings that @wordpress/eslint-plugin 27 (via @wordpress/scripts 36) started reporting in src/. Only doc comments change; no code does.

  • jsdoc/reject-function-type (24): each {Function} is now the callback's real signature, taken from how it is called, for example {(images: string[]) => void} or {(status: string, options?: Object) => void}.
  • jsdoc/escape-inline-tags (7): package names such as @wordpress/editor in doc comments are now wrapped in backticks, so they are not read as JSDoc tags.

lint-js --fix realigned the affected @param blocks to the wider type column, which accounts for most of the diff.

Testing

  • npm run lint: 0 errors, 0 warnings (was 31 warnings).
  • npm run build compiles; npm run test:unit: 364 passed.
  • Checked that every changed line is inside a doc comment.

@kraftbj
kraftbj added this pull request to the merge queue Oct 20, 2026
Merged via the queue into trunk with commit 82ae30e Oct 20, 2026
6 checks passed
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.

1 participant