fix: ensure docs include @returns Promise<void> where appropriate
#3954
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
kobenguyent
added
documentation
typescript
Collaborator
|
Thank you @fwouts |
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.
Motivation/Description of the PR
This PR fixes the generated
typings/types.d.tsdefinitions for methods that use Mustache docs. The intention is similar to #3465, but it fixes the original helper types instead.Note that there are still various methods that aren't typed properly, such as
Playwright._getPageUrl()(currently typed asvoid), because they are missing@returnJSDoc annotations. This should also be fixed, although it may make more sense to do this in a separate PR to keep this one focused.This fixes #3324.
Applicable helpers:
Type of change
Checklist:
addedupdatednpm run docs)npm run lint)npm test)