Skip to content

Commit 33cf45f

Browse files
becholsclaudebrianmacdonald-temporal
authored
Fix typos in Python SDK documentation (#4253)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Brian MacDonald <brian.macdonald@temporal.io>
1 parent 06bbc63 commit 33cf45f

10 files changed

Lines changed: 14 additions & 17 deletions

docs/develop/python/converters-and-encryption.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ If you aren't yet able to upgrade from Pydantic v1, see https://github.com/tempo
189189
### Custom Type Data Conversion
190190

191191
When converting from JSON, Workflow and Activity type hints are taken into account to convert to the proper types.
192-
All common Python typings including `Optional`, `Union`, all forms of iterables and mappings, and `NewType` are supported in addition the regular JSON values mentioned before.
192+
All common Python typings including `Optional`, `Union`, all forms of iterables and mappings, and `NewType` are supported in addition to the regular JSON values mentioned before.
193193

194194
In Python, Data Converters contain a reference to a Payload Converter class that is used to convert input and output payloads.
195195
By default, the Payload Converter is a `CompositePayloadConverter` which contains multiple `EncodingPayloadConverter`s to try to serialize/deserialize payloads.

docs/develop/python/core-application.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ _deterministic_.
220220

221221
One of the primary things that Workflows do is orchestrate the execution of Activities. An Activity is a normal function
222222
or method execution that's intended to execute a single, well-defined action (either short or long-running), such as
223-
querying a database, calling a third-party API, or transcoding a media file. An Activity can interact with world outside
223+
querying a database, calling a third-party API, or transcoding a media file. An Activity can interact with the world outside
224224
the Temporal Platform or use a Temporal Client to interact with a Temporal Service. For the Workflow to be able to
225225
execute the Activity, we must define the [Activity Definition](/activity-definition).
226226

@@ -244,7 +244,7 @@ serially, defeating the entire purpose of using `asyncio`. This can also lead to
244244
behavior that causes tasks to be unable to execute. Debugging these issues can be difficult and time consuming, as
245245
locating the source of the blocking call might not always be immediately obvious.
246246

247-
Due to this, consider not make blocking calls from within an asynchronous Activity, or use an async safe library to
247+
Due to this, consider not making blocking calls from within an asynchronous Activity, or use an async safe library to
248248
perform these actions. If you must use a blocking library, consider using a synchronous Activity instead.
249249

250250
:::

docs/develop/python/message-passing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -797,7 +797,7 @@ A dynamic Activity is a stand-in implementation.
797797
It's used when an Activity Task with an unknown Activity type is received by the Worker.
798798

799799
To participate, your Activity must opt into dynamic access.
800-
Adding `dynamic=True` to the `@activity.defn` decorator makes the Workflow Definition eligible to participate in dynamic invocation.
800+
Adding `dynamic=True` to the `@activity.defn` decorator makes the Activity Definition eligible to participate in dynamic invocation.
801801
You must register the Activity with the [Worker](https://python.temporal.io/temporalio.worker.html) before it can be invoked.
802802

803803
The Activity Definition must then accept a single argument of type `Sequence[temporalio.common.RawValue]`.

docs/develop/python/observability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Use the [list_workflows()](https://python.temporal.io/temporalio.client.Client.h
184184

185185
### How to set custom Search Attributes {#custom-search-attributes}
186186

187-
After you've created custom Search Attributes in your Temporal Service (using `temporal operator search-attribute create`or the Cloud UI), you can set the values of the custom Search Attributes when starting a Workflow.
187+
After you've created custom Search Attributes in your Temporal Service (using `temporal operator search-attribute create` or the Cloud UI), you can set the values of the custom Search Attributes when starting a Workflow.
188188

189189
Use `SearchAttributeKey` to create your Search Attributes. Then, when starting a Workflow execution using `client.start_workflow()`, include the Custom Search Attributes by passing instances of `SearchAttributePair()` containing each of your keys and starting values to a parameter called `search_attributes`.
190190
If you had Custom Search Attributes `CustomerId` of type `Keyword` and `MiscData` of type `Text`, you could provide these starting values:

docs/develop/python/python-sdk-sandbox.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ A default set of restrictions that prevents most dangerous standard library call
7171

7272
The following techniques aren't recommended, but they allow you to avoid, skip, or break through the sandbox environment.
7373

74-
Skipping Workflow Sandboxing results in a lack of determinism checks. Using the Workflow Sandboxing environment helps to preventing non-determinism errors but doesn't completely negate the risk.
74+
Skipping Workflow Sandboxing results in a lack of determinism checks. Using the Workflow Sandboxing environment helps prevent non-determinism errors but doesn't completely negate the risk.
7575

7676
### Skip Sandboxing for a block of code
7777

@@ -202,9 +202,9 @@ The sandbox's import notification policy specifies how the sandbox behaves when
202202
A dynamic import occurs when a module is imported after the Workflow is loaded into the sandbox. These imports are often invisible and, if they don't do anything restricted by the sandbox, cause memory overhead. By default the [`WARN_ON_DYNAMIC_IMPORT`](https://python.temporal.io/temporalio.workflow.SandboxImportNotificationPolicy.html#WARN_ON_DYNAMIC_IMPORT) policy setting is enabled and a warning will be emitted when a module that is not in the [passthrough modules](#passthrough-modules) list is dynamically imported.
203203

204204
The other notable policy settings apply when a module is imported into the sandbox that was not passed through. These settings are disabled by default and must be explicitly turned on.
205-
The [`WARN_ON_UNINTENTIONAL_PASSTHROUGH`](https://python.temporal.io/temporalio.workflow.SandboxImportNotificationPolicy.html#WARN_ON_UNINTENTIONAL_PASSTHROUGH) setting emits a warning when a module not included in the [passthrough modules](#passthrough-modules) list.
205+
The [`WARN_ON_UNINTENTIONAL_PASSTHROUGH`](https://python.temporal.io/temporalio.workflow.SandboxImportNotificationPolicy.html#WARN_ON_UNINTENTIONAL_PASSTHROUGH) setting emits a warning when a module not included in the [passthrough modules](#passthrough-modules) list is imported.
206206

207-
Similarly, the [`RAISE_ON_UNINTENTIONAL_PASSTHROUGH`](https://python.temporal.io/temporalio.workflow.SandboxImportNotificationPolicy.html#RAISE_ON_UNINTENTIONAL_PASSTHROUGH) setting will raise an error when an non-passed-through module is imported.
207+
Similarly, the [`RAISE_ON_UNINTENTIONAL_PASSTHROUGH`](https://python.temporal.io/temporalio.workflow.SandboxImportNotificationPolicy.html#RAISE_ON_UNINTENTIONAL_PASSTHROUGH) setting will raise an error when a non-passed-through module is imported.
208208

209209
The import notification policy can be set for specific imports by using [`sandbox_import_notification_policy`](https://python.temporal.io/temporalio.workflow.unsafe.html#sandbox_import_notification_policy) context manager.
210210

docs/develop/python/python-sdk-sync-vs-async.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ asynchronous Activity Definition.
212212
It makes
213213
a call to a microservice, accessed through HTTP, to request this
214214
greeting in Spanish. This Activity uses the `aiohttp` library to make an async
215-
safe HTTP request. Using the `requests` library here would have resulting in
215+
safe HTTP request. Using the `requests` library here would have resulted in
216216
blocking code within the async event loop, which will block the entire async
217217
event loop. For more in-depth information about this issue, refer to the
218218
[Python asyncio documentation](https://docs.python.org/3/library/asyncio-dev.html#running-blocking-code).

docs/develop/python/schedules.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ This page shows how to do the following:
4242

4343
**How to Schedule a Workflow Execution**
4444

45-
Scheduling Workflows is a crucial aspect of any automation process, especially when dealing with time-sensitive tasks. By scheduling a Workflow, you can automate repetitive tasks, reduce the need for manual intervention, and ensure timely execution of your business processes
45+
Scheduling Workflows is a crucial aspect of any automation process, especially when dealing with time-sensitive tasks. By scheduling a Workflow, you can automate repetitive tasks, reduce the need for manual intervention, and ensure timely execution of your business processes.
4646

47-
Use any of the following action to help Schedule a Workflow Execution and take control over your automation process.
47+
Use any of the following actions to help Schedule a Workflow Execution and take control over your automation process.
4848

4949
### Create a Scheduled Workflow {#create}
5050

docs/develop/python/temporal-client.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,9 +294,6 @@ overrides the option set in the configuration file.
294294
For example, the following TOML configuration file defines a `staging` profile with the necessary connection options to
295295
connect to Temporal Cloud via an API key:
296296

297-
For example, the following TOML configuration file defines a `staging` profile with the necessary connection options to
298-
connect to Temporal Cloud via an API key:
299-
300297
```toml
301298
# Cloud profile for Temporal Cloud
302299
[profile.staging]

docs/develop/python/versioning.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ Patching is a three-step process:
117117

118118
1. Patch in any new, updated code using the `patched()` function. Run the new patched code alongside old code.
119119
2. Remove old code and use `deprecate_patch()` to mark a particular patch as deprecated.
120-
3. Once there are no longer any open Worklow Executions of the previous version of the code, remove `deprecate_patch()`.
120+
3. Once there are no longer any open Workflow Executions of the previous version of the code, remove `deprecate_patch()`.
121121
Let's walk through this process in sequence.
122122

123123
### Patching in new code {#using-patched-for-workflow-history-markers}
@@ -260,4 +260,4 @@ This method also does not provide a way to version any still-running Workflows -
260260

261261
### Testing a Workflow for replay safety
262262

263-
To determine whether your Workflow your needs a patch, or that you've patched it successfully, you should incorporate [Replay Testing](/develop/python/testing-suite#replay).
263+
To determine whether your Workflow needs a patch, or that you've patched it successfully, you should incorporate [Replay Testing](/develop/python/testing-suite#replay).

docs/develop/python/worker-versioning-legacy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ See the [Pre-release README](https://github.com/temporalio/temporal/blob/main/do
2323
:::
2424

2525
A Build ID corresponds to a deployment. If you don't already have one, we recommend a hash of the code--such as a Git SHA--combined with a human-readable timestamp.
26-
To use Worker Versioning, you need to pass a Build ID to your Java Worker and opt in to Worker Versioning.
26+
To use Worker Versioning, you need to pass a Build ID to your Python Worker and opt in to Worker Versioning.
2727

2828
### Assign a Build ID to your Worker and opt in to Worker Versioning
2929

0 commit comments

Comments
 (0)