docs(locator): drop type markup from ariaSnapshotJSON details - #42136
Open
Simon Knott (Skn0tt) wants to merge 1 commit into
Open
docs(locator): drop type markup from ariaSnapshotJSON details#42136Simon Knott (Skn0tt) wants to merge 1 commit into
Simon Knott (Skn0tt) wants to merge 1 commit into
Conversation
Freeform Details prose is not run through the type renderer, so <[string]> survives into the MDX and breaks the Docusaurus build. microsoft/playwright.dev#2115 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: fd622800-f8e4-4a94-8f6d-73bdacd2f1d5
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
1 participant
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.
The freeform Details list on
locator.ariaSnapshotJSONused<[string]>/<[Object]>type markup. That syntax only gets escaped when it goes through the structured property renderer - in plain prose it lands in the MDX as-is and Docusaurus chokes on it (Unexpected character '[').That's what's breaking the docs roll: microsoft/playwright.dev#2115
Dropped the type annotations and left the field names + descriptions.