docs: clarify aria snapshot matching - #42596
Open
Chris (cpAdm) wants to merge 1 commit into
Open
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
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.
While investigating #38833, I also exercised failing ARIA snapshot assertions with coding agents. Better trace diffs would still help people review a failure, but these agents often need to repair the assertion from the terminal output. The recurring mistakes were treating templates as complete trees, misunderstanding
contain,equal, anddeep-equal, and copying invalid YAML or incorrectly escaped strings.Summary
Background
Some nested YAML examples omit the mapping colon required for child entries, and the C# verbatim-string example escapes the regular expression incorrectly. The matching and snapshot-update sections also describe behavior differently from the current parser, matcher, and test-runner update modes. These corrections make copied examples work and document the behavior users see at runtime.