docs(tap): fix awkward grammar in hasTouch note#40958
Open
adityasingh2400 wants to merge 1 commit into
Open
Conversation
The note in Page.tap had "[method: Page.tap] the method will throw..." which rendered as "page.tap() the method will throw..." in published docs, doubling up "tap" and "the method". Drop the redundant words. Touchscreen.tap had the same note copied verbatim with the wrong cross-reference; switch it to Touchscreen.tap so the link matches the method it documents. Frame.tap and Locator.tap already use a clean "<method> will throw / requires" form, so this brings Page.tap and Touchscreen.tap into line with them. Generated types.d.ts files are regenerated by npm run build to pick up the updated note text.
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 note in Page.tap currently reads
[`method: Page.tap`] the method will throw if [`option: Browser.newContext.hasTouch`] option of the browser context is false, which renders on playwright.dev aspage.tap() the method will throw.... The link expands topage.tap()so the trailingthe methodis redundant and the sentence reads as broken English.Touchscreen.tap had the same line copy-pasted, but the link still pointed at Page.tap rather than Touchscreen.tap itself. Swap the cross-reference so the link matches the method it documents.
Frame.tap and Locator.tap already use a clean
<method> will throw / requiresform. This brings Page.tap and Touchscreen.tap into line. Generated types.d.ts is regenerated bynpm run buildand picks up the updated note text.