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

Make spacingScale description more accurate in theme.json schema #44794

Merged
merged 1 commit into from
Oct 10, 2022

Conversation

t-hamano
Copy link
Contributor

@t-hamano t-hamano commented Oct 8, 2022

What?

This PR updates the description of spacingScale introduced by #41527

Why?

In the input support by JSON schema, the descriptions of spacingSizes and spacingScale are exactly the same, so it may be difficult to understand the difference between them.

spacingScale

spacingScale

spacingSizes

spacingSizes

Furthermore, spacingScale doesn'ot generate presets by itself, but is a property that defines the logic for generating presets.

How?

I have updated the description to what I think is appropriate according to what this property originally meant.

Testing Instructions

Create a JSON file that references the JSON schema for this branch, such as:

{
	"$schema": "https://raw.githubusercontent.com/WordPress/gutenberg/schema/theme-json-spacing-scale/schemas/json/theme.json",
	"version": 2,
	"settings": {
	}
}

In settings.spacingScale, confirm that the new description is proposed.

@t-hamano t-hamano added [Type] Developer Documentation Documentation for developers Developer Experience Ideas about improving block and theme developer experience labels Oct 8, 2022
@t-hamano t-hamano self-assigned this Oct 8, 2022
@t-hamano t-hamano marked this pull request as ready for review October 8, 2022 13:52
@t-hamano t-hamano requested a review from ajlende as a code owner October 8, 2022 13:52
@ajlende ajlende merged commit f8796da into trunk Oct 10, 2022
@ajlende ajlende deleted the schema/theme-json-spacing-scale branch October 10, 2022 18:43
@ajlende
Copy link
Contributor

ajlende commented Oct 10, 2022

Thanks for the change! spacingScale is more clear now

@github-actions github-actions bot added this to the Gutenberg 14.4 milestone Oct 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Developer Experience Ideas about improving block and theme developer experience [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants