fix(docs): change ref to target in browser_take_screenshot - #2130
Open
Wu Shuwen (dajiaohuang) wants to merge 1 commit into
Open
fix(docs): change ref to target in browser_take_screenshot#2130Wu Shuwen (dajiaohuang) wants to merge 1 commit into
Wu Shuwen (dajiaohuang) wants to merge 1 commit into
Conversation
Fixes #42517 The documentation for browser_take_screenshot incorrectly listed 'ref' as the parameter name for element screenshots. The actual parameter is 'target', as used in the implementation.
3 tasks
|
Heads-up: opened a broader docs PR that also fixes Tracking: microsoft/playwright#42539 (related to microsoft/playwright#42517). Happy for maintainers to take either your screenshots-only change or the combined PR — no hard feelings either way. |
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
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.
Summary
Fixes #42517
The documentation for browser_take_screenshot incorrectly listed
refas the parameter for element screenshots. The actual parameter istarget, as used in the implementation.Changes
reftotargetin the parameters table{ ref: "e12" }to{ target: "e12" }Verification
The
targetparameter is confirmed in the implementation atpackages/playwright-core/src/tools/backend/screenshot.ts.