Skip to content

Commit 0f1a16c

Browse files
committed
README updates
Fixes #59 Fixes #379
1 parent 00878ad commit 0f1a16c

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ Some things to note about the above code:
282282
does the same thing
283283
* Clients can have many more options not shown here (e.g. data converters and interceptors)
284284
* A string can be used instead of the method reference to call a workflow by name (e.g. if defined in another language)
285-
* Clients to not work across forks
285+
* Clients do not work across forks
286286

287287
Clients also provide a shallow copy of their config for use in making slightly different clients backed by the same
288288
connection. For instance, given the `client` above, this is how to have a client in another namespace:
@@ -732,6 +732,10 @@ The time-skipping `temporalio.testing.WorkflowEnvironment` can be created via th
732732
This internally downloads the Temporal time-skipping test server to a temporary directory if it doesn't already exist,
733733
then starts the test server which has special APIs for skipping time.
734734

735+
**NOTE:** The time-skipping test environment does not work on ARM. The SDK will try to download the x64 binary on macOS
736+
for use with the Intel emulator, but for Linux or Windows ARM there will be no proper time-skipping test server at this
737+
time.
738+
735739
##### Automatic Time Skipping
736740

737741
Anytime a workflow result is waited on, the time-skipping server automatically advances to the next event it can. To
@@ -1272,8 +1276,9 @@ Below are known compatibility issues with the Python SDK.
12721276
#### gevent Patching
12731277

12741278
When using `gevent.monkey.patch_all()`, asyncio event loops can get messed up, especially those using custom event loops
1275-
like Temporal. See [this gevent issue](https://github.com/gevent/gevent/issues/982) and
1276-
[this Python SDK issue](https://github.com/temporalio/sdk-python/issues/59) for more details.
1279+
like Temporal. See [this gevent issue](https://github.com/gevent/gevent/issues/982). This is a known incompatibility and
1280+
users are encouraged to not use gevent in asyncio applications (including Temporal). But if you must, there is
1281+
[a sample](https://github.com/temporalio/samples-python/tree/main/gevent_async) showing how it is possible.
12771282

12781283
# Development
12791284

0 commit comments

Comments
 (0)