Improve docs for block variation isActive
property
#60801
Merged
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?
While answering #60797, I noticed the docs for
isActive
aren't that clear, and I think it's easy for implementors to be confused about how to use it. I spent a few minutes working on the docs.How?
Note that I only made changes to the
isActive
section, the rest of the changes are from auto-formatting made by my IDE or post commit hook.BlockCard
andBreadcrumbs
, as non-contributors may not know what they areproviderNameSlug
is mentioned in the same paragraph as some of the API details, you can see in the issue I mentioned above this was misinterpreted. I've broken it into a separate paragraph and made clear it's an example of API usage.