Interactivity API: Add JSDoc comments to the public API #52469
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DAreRodz
added
the
[Feature] Interactivity API
|
Size Change: +171 B (0%) Total Size: 1.44 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 1bb98f3. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5507131083
|
|
@DAreRodz, is this ready for review? |
|
Yes, it is. 🙏 |
luisherranz
reviewed
Jul 13, 2023
8 tasks
|
@DAreRodz, is anything blocking the merge of this? |
Hey, @luisherranz; sorry for the delay. I prioritized other things, but I'm now addressing your feedback. This PR will be ready to merge in a moment. |
luisherranz
added
[Type] Enhancement
|
Thanks. Let me know once it's ready for another review 🙂 |
Co-authored-by: Luis Herranz <luisherranz@gmail.com>
Co-authored-by: Luis Herranz <luisherranz@gmail.com>
Co-authored-by: Luis Herranz <luisherranz@gmail.com>
DAreRodz
force-pushed
the
add/interactivity-api-jsdocs
branch
from
9a6bb07
to
4ec8dbb
Compare
|
@luisherranz, it's ready for review now. EDIT: I had to fix a jslint error that was accidentally included. |
DAreRodz
commented
Aug 7, 2023
packages/interactivity/src/store.js
Outdated
| * @param {Object} properties Properties to be added to the global store. | ||
| * @param {Object} [properties.state] State to be added to the global store. All | ||
| * the properties included here become reactive. | ||
| * @param {Object} [properties.block] Other properties to be added to the global store. |
There was a problem hiding this comment.
I believe this is not the correct way of documenting a variable that uses the spread operator. It seems to work somehow, but only for the docs, not for types. We could maybe remove it.
There was a problem hiding this comment.
I'll remove it for now, then.
luisherranz
approved these changes
Aug 7, 2023
packages/interactivity/src/store.js
Outdated
| * @param {Object} properties Properties to be added to the global store. | ||
| * @param {Object} [properties.state] State to be added to the global store. All | ||
| * the properties included here become reactive. | ||
| * @param {Object} [properties.block] Other properties to be added to the global store. |
|
Maybe we can add an |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Adds JSDoc comments to the
storeanddirectivefunctions, which are currently the public part of the Interactivity API.Why?
To start documenting the Interactivity API.
How?
I followed the format used for other JSDoc comments in the repository. I added basic support for typing, but it is very preliminary and not meant to be fully compatible with TypeScript yet.