Added doc tag support logic inside snippet tag #1072
Draft
+60
−7
Conversation
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
This was referenced Oct 9, 2025
Contributor
Author
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
2 times, most recently
from
2b6b68c to
984c187
Compare
shoplando
force-pushed
the
update-undefined-object-for-inline-snippets
branch
2 times, most recently
from
59d92da to
6189068
Compare
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
from
984c187 to
80f1e20
Compare
aswamy
approved these changes
Oct 14, 2025
Contributor
aswamy
left a comment
aswamy
left a comment
There was a problem hiding this comment.
Small comment. Nice stuff!
packages/theme-check-common/src/checks/unsupported-doc-tag/index.ts
Outdated
Show resolved
Hide resolved
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
4 times, most recently
from
24dbcf0 to
6465a20
Compare
shoplando
force-pushed
the
update-undefined-object-for-inline-snippets
branch
2 times, most recently
from
a2a2a95 to
d859b07
Compare
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
from
6465a20 to
0263556
Compare
2 tasks
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
from
0263556 to
9366de6
Compare
shoplando
force-pushed
the
update-undefined-object-for-inline-snippets
branch
from
d859b07 to
fa207a1
Compare
shoplando
force-pushed
the
add-doc-tag-snippet-support
branch
from
9366de6 to
b4049b2
Compare
shoplando
force-pushed
the
update-undefined-object-for-inline-snippets
branch
from
fa207a1 to
3274d57
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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 are you adding in this PR?
Solves #826
Updated theme check to support
doctag inside ofsnippettag. This change allows thedoctag to be used within inline snippets, in addition to the previously supported snippet and block contexts.This PR also makes the theme check more rigorous by ensuring the doc tag is either:
The error message has been updated to reflect this new support, and tests have been added to verify that
doctags inside inline snippets don't trigger errors.What's next? Any followup issues?
Update the theme check docs
Before you deploy
changeset