Skip to content

fix: remove pre-release docs from README #600

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

Merged
merged 1 commit into from
Mar 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,39 +288,3 @@ asyncio.run(main())
## Documentation

Check out our [new documentation site](https://playwright.dev/python/docs/intro)!

## Is Playwright ready?

Yes, Playwright for Python is ready! The latest version of Playwright for
Python is 1.8.0a. We are ready to drop the Alpha bit once we hear from you.
Once it is gone, we will become semver compatible and the API will be
frozen in its present form for years. We will still be adding features with
every release, but we promise to not break it anymore!

## Migration from the pre-release versions

The API has changed since the last 0.170.0 version:

- Snake case notation for methods and arguments:

```py
# old
browser.newPage()
```

```py
# new
browser.new_page()
```

- Import has changed to include sync vs async mode explicitly:
```py
# old
from playwright import sync_playwright
```
```py
# new
from playwright.sync_api import sync_playwright
```

That's about it! Our new [doc site](https://playwright.dev/python/docs/intro) uses proper notation and examples for the new API.
2 changes: 0 additions & 2 deletions playwright/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,4 @@
Python package `playwright` is a Python library to automate Chromium,
Firefox and WebKit with a single API. Playwright is built to enable cross-browser
web automation that is ever-green, capable, reliable and fast.
For more information you'll find the documentation for the sync API [here](sync_api.html)
and for the async API [here](async_api.html).
"""