microsoft / microsoft/playwright-dotnet
Documentation is wrong for Page.WaitFor functions
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 3k
- Forks
- 304
- Avg merge
- 20h 47m
- Merged PRs (30d)
- 6
Description
The documentation for the various WaitFor functions seems to be a copy of the associated RunAndWaitFor function. See https://playwright.dev/dotnet/docs/api/class-page. The documentation describes performing the action. The documentation has an action parameter. Only the RunAndWaitFor functions have the action parameter.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Page API documentation linked in the issue and compare each WaitFor function with its associated RunAndWaitFor function. Update the WaitFor descriptions so they describe waiting rather than performing an action, and remove the action parameter where it does not apply; done when the generated documentation matches the APIs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100