Skip to content

Add JSDoc block for getSectionRootClientId in block editor package #65219

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.

Sign up for GitHub

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

Jump to bottom
Merged
colorful-tones merged 2 commits into from
Sep 16, 2024
Merged

Add JSDoc block for getSectionRootClientId in block editor package #65219

colorful-tones merged 2 commits into from
Sep 16, 2024

Conversation

@colorful-tones
Copy link
Member

@colorful-tones colorful-tones commented Sep 10, 2024

What?

Addresses #65213

Why?

Adding documentation to existing block-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 JSDocs formatted doc blocks to existing getSectionRootClientId.

Testing Instructions

Testing Instructions for Keyboard

n/a

@colorful-tones colorful-tones requested review from Mamaduka and getdave and removed request for ellatrix September 10, 2024 21:55
@github-actions
Copy link

github-actions bot commented Sep 10, 2024 •
edited
Loading

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 <[email protected]>
Co-authored-by: getdave <[email protected]>
Co-authored-by: Mamaduka <[email protected]>

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

@colorful-tones colorful-tones added the [Type] Developer Documentation Documentation for developers label Sep 10, 2024
@colorful-tones colorful-tones self-assigned this Sep 10, 2024
getdave
getdave reviewed Sep 11, 2024
View reviewed changes
Copy link
Contributor

@getdave getdave left a comment

Choose a reason for hiding this comment

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

I had this on my todo for today but I appreciate you raising this one 👍

A few tweaks to the wording to express the state as I intended it.

@colorful-tones
Copy link
Member Author

colorful-tones commented Sep 11, 2024

Out sick today, and will circle back and get the suggested updates in place. Thanks!

@colorful-tones colorful-tones enabled auto-merge (squash) September 11, 2024 17:06
getdave
getdave approved these changes Sep 16, 2024
View reviewed changes
Copy link
Contributor

@getdave getdave left a comment

Choose a reason for hiding this comment

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

This is a good improvement. Thank you for following up.

@colorful-tones colorful-tones merged commit 38e74db into WordPress:trunk Sep 16, 2024
@github-actions github-actions bot added this to the Gutenberg 19.3 milestone Sep 16, 2024
@colorful-tones colorful-tones deleted the update/block-editor-docs-private-selectors branch September 16, 2024 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@getdave getdave getdave approved these changes

@Mamaduka Mamaduka Awaiting requested review from Mamaduka

Assignees

@colorful-tones colorful-tones

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Milestone

Gutenberg 19.3

Development

Successfully merging this pull request may close these issues.

3 participants

@colorful-tones @Mamaduka @getdave