Skip to content

JSDoc: fix alignments, indentation, and unnecessary hyphen - #13490

Closed
afercia wants to merge 3 commits into
WordPress:trunkfrom
afercia:jsdoc-alignments-indentation
Closed

JSDoc: fix alignments, indentation, and unnecessary hyphen#13490
afercia wants to merge 3 commits into
WordPress:trunkfrom
afercia:jsdoc-alignments-indentation

Conversation

@afercia

@afercia afercia commented Sep 11, 2026

Copy link
Copy Markdown
Member

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

  • Enables the following JSDoc rules:
    • jsdoc/check-alignment
    • jsdoc/check-indentation
    • jsdoc/check-line-alignment
    • jsdoc/require-hyphen-before-param-description -> never
  • Fixes all the violations.

This is a purely formatting fix.

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 11, 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.

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

Props afercia, mukesh27.

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.

Comment thread src/js/_enqueues/wp/api.js Outdated
*
*/
* Types that don't support trashing require passing ?force=true to delete.
*

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.

Suggested change
*

Let's remove these empty line.

@afercia
afercia force-pushed the jsdoc-alignments-indentation branch from 2d3872e to d077aa1 Compare September 11, 2026 09:37
@afercia afercia changed the title Jsdoc fix alignments, indentation, and unnecessary hyphen JSDoc: fix alignments, indentation, and unnecessary hyphen Sep 11, 2026
wporg-sync pushed a commit that referenced this pull request Sep 11, 2026
…ation blocks.

Enables the following JSDoc rules:
- `jsdoc/check-alignment`
- `jsdoc/check-indentation`
- `jsdoc/check-line-alignment`
- `jsdoc/require-hyphen-before-param-description` -> never
Fixes all the reported violations. Also removes hyphens before descriptions.

Part of the effort to improve JS inline documentation for 7.2.

Developed in #13490

Props afercia, mukesh27.
See #66033.


git-svn-id: https://develop.svn.wordpress.org/trunk@63600 602fd350-edb4-49c9-b593-d223f7449a82
@afercia

afercia commented Sep 11, 2026

Copy link
Copy Markdown
Member Author

@afercia afercia closed this Sep 11, 2026
@afercia
afercia deleted the jsdoc-alignments-indentation branch September 11, 2026 10:51
wporg-sync pushed a commit to WordPress/WordPress that referenced this pull request Sep 11, 2026
…ation blocks.

Enables the following JSDoc rules:
- `jsdoc/check-alignment`
- `jsdoc/check-indentation`
- `jsdoc/check-line-alignment`
- `jsdoc/require-hyphen-before-param-description` -> never
Fixes all the reported violations. Also removes hyphens before descriptions.

Part of the effort to improve JS inline documentation for 7.2.

Developed in WordPress/wordpress-develop#13490

Props afercia, mukesh27.
See #66033.

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


git-svn-id: http://core.svn.wordpress.org/trunk@62776 1a063a9b-81f0-0310-95a4-ce76da25c4cd
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