Style engine: update terminology and docs #41964
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gathering a list of terms.
ramonjd
added
[Type] Developer Documentation
ramonjd
requested review from
andrewserong,
youknowriad,
aaronrobertshaw and
glendaviesnz
and removed request for
andrewserong
There was a problem hiding this comment.
Nice one, thanks for improving the documentation and adding better clarity to the variable names 👍
It's a bit nit-picky, but I left a couple of comments to see if we need the _array suffix on the variable names. I was wondering if we changed some of the names to be more different to each other, if that'd remove the need for the suffix?
|
Whoops I broke something 😸 Unit tests failing... Fixing... |
Cleaning up a few loose ends. Definition should have been declaration :D
Fixed! T'was a typo. |
andrewserong
approved these changes
Jun 28, 2022
There was a problem hiding this comment.
Thanks for the updates @ramonjd, the changes look good to me, and I smoke tested to make sure it's still working with server-generated styles and individual sides:
LGTM 🎉
25 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This PR adds a glossary that contains terms and definitions used by the style engine.
It also updates comments and var names so that they're consistent with the definitions.
Part of:
Why?
To ensure consistency and to reflect proper usage.
How?
⌨️
Testing Instructions
Direct link to README.md (so you don't have to parse through HTML tags)
npm run test-unit-php /var/www/html/wp-content/plugins/gutenberg/packages/style-engine/phpunit/class-wp-style-engine-test.php