Skip to content

Jsdoc: add require param description rule - #13475

Closed
afercia wants to merge 4 commits into
WordPress:trunkfrom
afercia:jsdoc-add-require-param-description
Closed

Jsdoc: add require param description rule#13475
afercia wants to merge 4 commits into
WordPress:trunkfrom
afercia:jsdoc-add-require-param-description

Conversation

@afercia

@afercia afercia commented Sep 10, 2026

Copy link
Copy Markdown
Member

See https://core.trac.wordpress.org/ticket/66033

  • Enables the JSDoc rule require-param-description.
  • Fixes all the reported violations.

Run npm run lint:jsdoc and observe there are no reported violations.

Use of AI Tools

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 Sep 10, 2026 •
edited
Loading

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.

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

Props afercia, westonruter.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@afercia
afercia requested a lite review from Copilot September 10, 2026 10:21
Copilot AI reviewed Sep 10, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Sep 10, 2026

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 requested a review from westonruter September 10, 2026 10:48
westonruter
westonruter approved these changes Sep 10, 2026
View reviewed changes

@westonruter westonruter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions, but pre-approving.

Comment thread src/js/_enqueues/wp/media/models.js Outdated
Comment thread src/js/media/views/modal.js Outdated
Comment thread src/js/media/views/toolbar.js Outdated
@afercia
afercia force-pushed the jsdoc-add-require-param-description branch from 24e3631 to 39fe24b Compare September 11, 2026 06:26
@afercia

afercia commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

Committed in https://core.trac.wordpress.org/changeset/63598

@afercia afercia closed this Sep 11, 2026
wporg-sync pushed a commit that referenced this pull request Sep 11, 2026
@afercia
General: Enable the JSDoc rule require-param-description.
501d920 
Enables the JSDoc rule `require-param-description` and fixes all the reported violations.
Part of the effort to improve JS inline documentation for 7.2.

Developed in #13475

Props afercia, westonruter.
See #66033.


git-svn-id: https://develop.svn.wordpress.org/trunk@63598 602fd350-edb4-49c9-b593-d223f7449a82
@afercia
afercia deleted the jsdoc-add-require-param-description branch September 11, 2026 06:30
wporg-sync pushed a commit to WordPress/WordPress that referenced this pull request Sep 11, 2026
@afercia
General: Enable the JSDoc rule require-param-description.
d9b6e3d 
Enables the JSDoc rule `require-param-description` and fixes all the reported violations.
Part of the effort to improve JS inline documentation for 7.2.

Developed in WordPress/wordpress-develop#13475

Props afercia, westonruter.
See #66033.

Built from https://develop.svn.wordpress.org/trunk@63598


git-svn-id: http://core.svn.wordpress.org/trunk@62774 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@westonruter westonruter westonruter approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@afercia @westonruter