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

fix: innerBlocks schema description in block.json #58649

Merged
merged 3 commits into from
Feb 6, 2024

Conversation

shreyash3087
Copy link
Contributor

What?

This PR corrects the schema description for example.innerBlocks in the block schema to accurately reflect the expected format.

Fixes #58381

Why?

The incorrect description was causing confusion for users and potentially leading to incorrect usage of the innerBlocks property. This PR is necessary to provide clear and accurate instructions for defining inner blocks within the block example.

How?

This PR updates the description in the block schema file (block.json) to match the correct format for defining inner blocks. It removes syntax errors and provides clear instructions on how to use the innerBlocks property.

Testing Instructions

  1. Open block.json.
  2. Look for innerBlocks Description

Testing Instructions for Keyboard

1.Navigate to block.json using keyboard navigations.
2.Head down to around 700 lines and search for innerBlocks description.

Screenshots or screencast

Screenshot2

@shreyash3087 shreyash3087 requested a review from ajlende as a code owner February 4, 2024 06:34
Copy link

github-actions bot commented Feb 4, 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.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @shreyash3087, @MHRSRoni.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

Core SVN

If you're a Core Committer, use this list when committing to wordpress-develop in SVN:

Props: wildworks, ocean90.

GitHub Merge commits

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

Unlinked contributors: shreyash3087, MHRSRoni.

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: ocean90 <ocean90@git.wordpress.org>

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

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Feb 4, 2024
Copy link

github-actions bot commented Feb 4, 2024

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @shreyash3087! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

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.

Thanks for the PR!

I think this approach makes sense, but I'll leave a comment with the code example.

schemas/json/block.json Outdated Show resolved Hide resolved
@t-hamano t-hamano added the [Type] Developer Documentation Documentation for developers label Feb 5, 2024
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
@shreyash3087
Copy link
Contributor Author

@t-hamano Thanks for taking the time to review my pull request and providing your valuable feedback,i updated the code accordingly as per your suggestion.This was my first contribution to open source, so i truly appreciate your guidance.

@t-hamano t-hamano self-requested a review February 5, 2024 10:27
@shreyash3087
Copy link
Contributor Author

@t-hamano Thank you for the correction! I have updated the description in the block.json file. Sorry for the inconvenience here,but i don't know why the 'End-to-End Tests / Puppeteer (pull_request)' is now failing after 9m,i looked into the details its a TimeoutError. But i couldnt find the reason behind that. Please review the changes and the error at your convenience. Your guidance is greatly appreciated!

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.

LGTM ! The description is showing up as expected for me.

Before:

before

After:

after

i don't know why the 'End-to-End Tests / Puppeteer (pull_request)' is now failing

Don't worry, e2e test can be unstable at times 😅 I would like to rerun the test and merge it if it passes.

@t-hamano t-hamano merged commit 8afe850 into WordPress:trunk Feb 6, 2024
55 checks passed
Copy link

github-actions bot commented Feb 6, 2024

Congratulations on your first merged pull request, @shreyash3087! We'd like to credit you for your contribution in the post announcing the next WordPress release, but we can't find a WordPress.org profile associated with your GitHub account. When you have a moment, visit the following URL and click "link your GitHub account" under "GitHub Username" to link your accounts:

https://profiles.wordpress.org/me/profile/edit/

And if you don't have a WordPress.org account, you can create one on this page:

https://login.wordpress.org/register

Kudos!

@github-actions github-actions bot added this to the Gutenberg 17.7 milestone Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Block schema: Incorrect description for innerBlocks example
2 participants