Skip to content

Conversation

@DAreRodz
Copy link
Contributor

What?

Warning

This PR has been created on top of #70353. Wait for that PR to be merged before merging this one.

Improves TSDoc comments to use third-person singular verbs. Additionally, corrects typos and other formatting errors.

Why?

To adhere to the WordPress JavaScript Documentation standard.

Functions and closures are third-person singular elements, meaning third-person singular verbs should be used to describe what each does.

@DAreRodz DAreRodz requested a review from SantosGuillamot June 13, 2025 17:01
@DAreRodz DAreRodz requested a review from luisherranz as a code owner June 13, 2025 17:01
@DAreRodz DAreRodz added [Type] Code Quality Issues or PRs that relate to code quality [Feature] Interactivity API API to add frontend interactivity to blocks. [Package] Interactivity /packages/interactivity [Package] Interactivity Router /packages/interactivity-router labels Jun 13, 2025
Copy link
Member

@luisherranz luisherranz left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions
Copy link

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: DAreRodz <[email protected]>
Co-authored-by: luisherranz <[email protected]>

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

Base automatically changed from feature/iapi-new-client-side-navigation to trunk June 18, 2025 07:20
@DAreRodz DAreRodz force-pushed the backport/iapi-update-comments-format branch from 5cb0d86 to acf4213 Compare June 18, 2025 07:27
@DAreRodz DAreRodz enabled auto-merge (squash) June 18, 2025 07:55
@DAreRodz DAreRodz merged commit 1411911 into trunk Jun 18, 2025
59 checks passed
@DAreRodz DAreRodz deleted the backport/iapi-update-comments-format branch June 18, 2025 08:01
@github-actions github-actions bot added this to the Gutenberg 21.1 milestone Jun 18, 2025
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
…nts (WordPress#70420)

* Use third-person singular verbs

* Fix typo

* Use third-person singular verbs in the interactivity package

* Remove old comment

* Fix more typos

* Update other TSDocs that were using infinitive

* Update remaining infinitive verbs in TSDocs

* Update `useMemo`'s TSDoc

------

Co-authored-by: DAreRodz <[email protected]>
Co-authored-by: luisherranz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Feature] Interactivity API API to add frontend interactivity to blocks. [Package] Interactivity Router /packages/interactivity-router [Package] Interactivity /packages/interactivity [Type] Code Quality Issues or PRs that relate to code quality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants