docs: move note #36432
Merged
docs: move note #36432
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR moves and consolidates the note about the snapshot path parameter to a more appropriate position in the documentation.
- The relocated note now clearly explains that the
nameparameter accepts an array of path segments for snapshot files. - The duplicated note regarding
snapshotNamewas removed to reduce redundancy.
Comments suppressed due to low confidence (1)
docs/src/test-snapshots-js.md:49
- Ensure the use of
namehere (instead ofsnapshotNamefound in the removed note) is intentional and consistent with the rest of the documentation.
> Note that `name` also accepts an array of path segments to the snapshot file such as `expect().toHaveScreenshot(['relative', 'path', 'to', 'snapshot.png'])`.
Skn0tt
reviewed
Jun 26, 2025
Member
Skn0tt
left a comment
Skn0tt
left a comment
There was a problem hiding this comment.
good catch, thank you! let's move it to a slightly different spot.
|
|
||
| - `chromium-darwin` - the browser name and the platform. Screenshots differ between browsers and platforms due to different rendering, fonts and more, so you will need different snapshots for them. If you use multiple projects in your [configuration file](./test-configuration.md), project name will be used instead of `chromium`. | ||
|
|
||
| The snapshot name and path can be configured with [`property: TestConfig.snapshotPathTemplate`] in the playwright config. |
Member
There was a problem hiding this comment.
I think the note should go under this section. otherwise it disrupts the enumaration flow, reads weird to me.
Skn0tt
approved these changes
Jun 26, 2025
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.
It looks to me like the note is in the wrong place