Skip to content

Commit 2d4405e

Browse files
authored
Clarify README (#44)
1 parent 0f134e2 commit 2d4405e

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -599,13 +599,13 @@ poetry install --no-root
599599

600600
Now perform the release build:
601601

602+
> This will take a while because Rust will compile the core project in release mode (see [Local SDK development
603+
environment](#local-sdk-development-environment) for the quicker approach to local development).
604+
602605
```bash
603606
poetry build
604607
```
605608

606-
This will take a while because Rust will compile the core project in release mode (see "Local SDK development
607-
environment" for the quicker approach to local development).
608-
609609
The compiled wheel doesn't have the exact right tags yet for use, so run this script to fix it:
610610

611611
```bash
@@ -651,8 +651,14 @@ if __name__ == "__main__":
651651
asyncio.run(main())
652652
```
653653

654-
Assuming there is a [local Temporal server](https://docs.temporal.io/docs/server/quick-install/) running, executing the
655-
file with `python` (or `python3` if necessary) will give:
654+
Assuming there is a [local Temporal server](https://docs.temporal.io/docs/server/quick-install/) running, execute the
655+
file with `python` (or `python3` if necessary):
656+
657+
```bash
658+
python example.py
659+
```
660+
661+
It should output:
656662

657663
Result: Hello, Temporal!
658664

@@ -703,4 +709,4 @@ poe test
703709
rarely in library code for some Python common items (e.g. `dataclass` or `partial`), but not allowed to do this for
704710
any `temporalio` packages or any classes/functions that aren't clear when unqualified.
705711
* We allow relative imports for private packages
706-
* We allow `@staticmethod`
712+
* We allow `@staticmethod`

0 commit comments

Comments
 (0)