Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Improve documentation, document returned type for all methods #5510

Closed
dcaillibaud opened this issue Feb 19, 2021 · 3 comments
Closed
Assignees

Comments

@dcaillibaud
Copy link

Documentation is really clear and well organized, but for some methods return type isn't mentionned, and it's sometimes difficult to know if the method is async or not, for example on https://playwright.dev/docs/api/class-browsercontext#browsercontextclearcookies (for others, return type isn't mentionned but a sample code allow guessing).

Thanks

@aslushnikov
Copy link
Collaborator

difficult to know if the method is async or not, for example on https://playwright.dev/docs/api/class-browsercontext#browsercontextclearcookies

@dcaillibaud That's a good point!

for others, return type isn't mentionned but a sample code allow guessing

Can you please give some examples? This looks like a bug.

@aslushnikov
Copy link
Collaborator

Ah, I found that https://playwright.dev/docs/api/class-browsercontext/#browsercontextclearcookies is actually doesn't have a return type at all. That's definitely a bug.

@dgozman
Copy link
Contributor

dgozman commented May 10, 2021

This is now fixed for the @next, and future releases. See https://playwright.dev/docs/next/api/class-browsercontext#browsercontextclearcookies for example.

@dgozman dgozman closed this as completed May 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants