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

Docs: Clarify that blockGap support depends on layout support #53254

Merged

Conversation

andrewserong
Copy link
Contributor

What?

A small update to developer docs to clarify that spacing.blockGap only works for blocks that use the layout block support.

Why?

As discussed in #53155 (comment) it isn't clear that spacing.blockGap depends on the layout block support. Now that the layout block support is stable and documented, let's connect the two a tiny bit more in the documentation.

How?

  • Add a sentence to the What is blockGap docs to link to the layout block support.
  • Update the comment for spacing.blockGap that it is for blocks that opt in to layout.

I'm sure we could also add more detailed info in the future, but hopefully for now this adds a little bit of clarity.

Testing Instructions

Proof read, and double check that the included link correctly links to the right section of the block supports documentation.

@github-actions
Copy link

github-actions bot commented Aug 2, 2023

Flaky tests detected in 078df84.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5734085674
📝 Reported issues:

Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

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

Here, take a 🧇

Edit: read well to me. Thanks for the addition 😄

Copy link
Contributor

@tellthemachines tellthemachines left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@andrewserong andrewserong merged commit e898601 into trunk Aug 2, 2023
@andrewserong andrewserong deleted the update/docs-to-clarify-block-gap-depends-on-layout branch August 2, 2023 03:36
@github-actions github-actions bot added this to the Gutenberg 16.4 milestone Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Layout Layout block support, its UI controls, and style output. [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants