Skip to content

Commit 4075079

Browse files
committed
docs: update migration guide sync api notice
1 parent 984ad07 commit 4075079

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

UPDATING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,8 @@ To see which versions of Python we test the SDK against, please look at our
8686
The 1.2.0 version introduces a breaking change, which changes the way of interacting with the SDK from synchronous to asynchronous, using [the `asyncio` foundational library](https://docs.python.org/3.7/library/asyncio.html) to provide support for `async`/`await` syntax.
8787
Because of this breaking change, every call that interacts with the Ably REST API must be refactored to this asynchronous way.
8888

89-
Important Update:
90-
- If you want to keep using old synchronous style API, import `AblyRestSync` client instead.
91-
- This is applicable only for Ably REST APIs.
89+
For backwards compatibility, in ably-python 2.0.2 we have added a backwards compatible REST client so that you can still use the synchronous version of the REST interface if you are migrating forwards from version 1.1.
90+
In order to use the synchronous variant, you can import the `AblyRestSync` constructor from `ably.sync`:
9291

9392
```python
9493
from ably.sync import AblyRestSync
@@ -270,4 +269,4 @@ Must now be replaced with this new style, asynchronous form:
270269
```python
271270
await client.time()
272271
await client.close()
273-
```
272+
```

0 commit comments

Comments
 (0)