Augment Block.Edit filter docs with performance guidance#55252
Merged
Conversation
Contributor
Author
|
Validity of this PR depends on whether fix in #55250 is 👌 |
getdave
requested review from
ajitbohra,
fabiankaegy,
juanmaguitar,
ndiego and
ryanwelcher
as code owners
jorgefilipecosta
approved these changes
Oct 13, 2023
jorgefilipecosta
left a comment
jorgefilipecosta
left a comment
Member
There was a problem hiding this comment.
It seems like a good enhancement to the docs as the filter should be used carefully. Adding a note makes sense.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Adds some performance guidance/warnings to the docs around the
Block.Editfilter.Why?
It's easy to introduce performance regressions using these filters. See #55250. We should help folks to avoid this.
How?
Adds a note to remind consumers that the hook is expensive and can introduce perf regressions. It prompts consumers to conditionally render their custom output especially if it's not needed on all blocks.
Testing Instructions
Read words.
Testing Instructions for Keyboard
Screenshots or screencast