Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: EntitiesSavedStates editor component #62377

Conversation

colorful-tones
Copy link
Member

What? & Why?

Addresses one item in #60358

Adding documentation to existing editor components can help with any of the following:

  • encourages knowledge sharing and quicker onboarding for future devs
  • supports maintenance and troubleshooting
  • mitigates risk

How?

Add a JSDoc comment to the EntitiesSavedStates component and run npm run docs:build to populate the README with the newly added documents.

@colorful-tones colorful-tones marked this pull request as ready for review June 6, 2024 17:35
@colorful-tones colorful-tones enabled auto-merge (squash) June 6, 2024 17:35
Copy link

github-actions bot commented Jun 6, 2024

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: colorful-tones <colorful-tones@git.wordpress.org>

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

@colorful-tones colorful-tones merged commit e348235 into WordPress:trunk Jun 7, 2024
65 of 66 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.6 milestone Jun 7, 2024
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
* Add JSDoc block for EntitiesSavedStatesExtensible function

* Add JSDoc block for EntitiesSavedStates editor component

* Auto-generate editor component docs for EntitiesSavedStates
@afercia
Copy link
Contributor

afercia commented Nov 26, 2024

While investigating #67313 I noticed the documentation of the renderDialog prop may not be accurate. To me, it seems it's just a boolean flag that switches the component to render some ARIA properties and make it behave like a modal dialog as implemented in #59622
Instead, it's documented as a {Function} to render the modal dialog here, here, and here.

Am I missing something? @colorful-tones @ntsekouras could you please have a look, when you have a chance?

@ntsekouras
Copy link
Contributor

Instead, it's documented as a {Function} to render the modal dialog here, here, and here.

Am I missing something? @colorful-tones @ntsekouras could you please have a look, when you have a chance?

No, it seems you're right. We missed that..

@afercia
Copy link
Contributor

afercia commented Dec 2, 2024

Thanks for the feedback. It will be fixed either in #67351 or #67352 (where renderDialog is removed).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants