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

BlockInspector: Add showNoBlockSelectedMessage prop documentation. #68444

Merged

Conversation

SainathPoojary
Copy link
Contributor

related to #22891

What?

This PR adds missing documentation for the showNoBlockSelectedMessage prop in the BlockInspector component.

Why?

The showNoBlockSelectedMessage prop was introduced but lacked documentation. Adding this prop to the README ensures that developers understand its purpose and usage when working with the BlockInspect

Testing Instructions

  1. Navigate to the BlockInspector component's README file.
  2. Verify that the showNoBlockSelectedMessage prop is documented correctly.
  3. Ensure that the prop’s description is clear, including its default value and type.

Copy link

github-actions bot commented Jan 1, 2025

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: SainathPoojary <[email protected]>
Co-authored-by: t-hamano <[email protected]>

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

@SainathPoojary
Copy link
Contributor Author

Hey @t-hamano,

The README was missing documentation for the showNoBlockSelectedMessage prop. I’ve added it in the PR. Could you please review the changes when you have a moment?

Thanks!

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers [Package] Block editor /packages/block-editor labels Jan 2, 2025
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

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

Nice catch!

@SainathPoojary
Copy link
Contributor Author

Thank you for catching that, @t-hamano! I’ve updated the Markdown list to use the recommended 3 spaces for consistency. Let me know if there’s anything else that needs attention.

@t-hamano t-hamano merged commit 78e961d into WordPress:trunk Jan 3, 2025
61 checks passed
@github-actions github-actions bot added this to the Gutenberg 20.1 milestone Jan 3, 2025
@Mamaduka
Copy link
Member

Mamaduka commented Jan 4, 2025

I think we should just remove this prop. It hasn't been used anywhere in the the core for a while. Here's the PR: #68487.

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

Successfully merging this pull request may close these issues.

3 participants