Skip to content

Commit 2a014ea

Browse files
becholsclaudebrianmacdonald-temporal
authored
Fix typos in .NET, PHP, Ruby SDK documentation (#4255)
* Fix typos in .NET, PHP, Ruby SDK and top-level develop documentation Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]> * Update docs/develop/php/core-application.mdx --------- Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]> Co-authored-by: Brian MacDonald <[email protected]>
1 parent 43de4d8 commit 2a014ea

21 files changed

+36
-41
lines changed

docs/develop/activity-retry-simulator.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ tags:
88
---
99

1010
Use this tool to visualize total Activity Execution times and experiment with different Activity timeouts and Retry Policies.
11-
For a list of Activity Task Execution times, use [this calculator](https://temporal-time.netlify.app/?initialInterval=1&maxInterval=100&maxReties=10&backoffCoeificent=2).
11+
For a list of Activity Task Execution times, use [this calculator](https://temporal-time.netlify.app/?initialInterval=1&maxInterval=100&maxReties=10&backoffCoefficient=2).
1212

1313
The simulator is based on a common Activity use-case, which is to call a third party HTTP API and return the results.
1414
See the example code snippets below.

docs/develop/dotnet/core-application.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Here are some known gotchas to avoid with .NET tasks inside of Workflows:
114114

115115
In order to help catch wrong scheduler use, by default the Temporal .NET SDK adds an event source listener for info-level task events.
116116
While this technically receives events from all uses of tasks in the process, we make sure to ignore anything that is not running in a Workflow in a high performant way (basically one thread local check).
117-
For code that does run in a Workflow and accidentally starts a task in another scheduler, an `InvalidWorkflowOperationException` will be thrown which "pauses" the Workflow (fails the Workflow Rask which continually retries until the code is fixed).
117+
For code that does run in a Workflow and accidentally starts a task in another scheduler, an `InvalidWorkflowOperationException` will be thrown which "pauses" the Workflow (fails the Workflow Task which continually retries until the code is fixed).
118118
This is unfortunately a runtime-only check, but can help catch mistakes early. If this needs to be turned off for any reason, set `DisableWorkflowTracingEventListener` to `true` in Worker options.
119119

120120
In the near future for modern .NET versions we hope to use the
@@ -247,7 +247,7 @@ Technically this can be multiple parameters, but Temporal strongly encourages a
247247

248248
Calls to spawn [Activity Executions](/activity-execution) are written within a [Workflow Definition](/workflow-definition).
249249
The call to spawn an Activity Execution generates the [ScheduleActivityTask](/references/commands#scheduleactivitytask) Command.
250-
This results in the set of three [Activity Task](/tasks#activity-task) related Events ([ActivityTaskScheduled](/references/events#activitytaskscheduled), [ActivityTaskStarted](/references/events#activitytaskstarted), and ActivityTask[Closed])in your Workflow Execution Event History.
250+
This results in the set of three [Activity Task](/tasks#activity-task) related Events ([ActivityTaskScheduled](/references/events#activitytaskscheduled), [ActivityTaskStarted](/references/events#activitytaskstarted), and ActivityTask[Closed]) in your Workflow Execution Event History.
251251

252252
A single instance of the Activities implementation is shared across multiple simultaneous Activity invocations.
253253
Activity implementation code should be _idempotent_.
@@ -285,7 +285,7 @@ These values are set in the Activity Options.
285285

286286
**How to get the results of an Activity Execution using the Temporal .NET SDK**
287287

288-
The Activity result is the returned in the task from the `ExecuteActivityAsync` call.
288+
The Activity result is returned in the task from the `ExecuteActivityAsync` call.
289289

290290
## Run Worker Process
291291

docs/develop/dotnet/debugging.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ tags:
2020
This page shows how to do the following:
2121

2222
- [Debug in a development environment](#debug-in-a-development-environment)
23-
- [Debug in a development production](#debug-in-a-development-production)
23+
- [Debug in a production environment](#debug-in-a-development-production)
2424

2525
### Debug in a development environment {#debug-in-a-development-environment}
2626

@@ -30,9 +30,9 @@ In developing Workflows, you can use the normal development tools of logging and
3030
In addition to the normal development tools of logging and a debugger, you can also see what’s happening in your Workflow by using the [Web UI](/web-ui) or [Temporal CLI](/cli).
3131
The Web UI provides insight into your Workflows, making it easier to identify issues and monitor the state of your Workflows in real time.
3232

33-
### Debug in a development production {#debug-in-a-development-production}
33+
### Debug in a production environment {#debug-in-a-development-production}
3434

35-
**How to debug in a development production using the Temporal .NET SDK**
35+
**How to debug in a production environment using the Temporal .NET SDK**
3636

3737
You can debug production Workflows using:
3838

docs/develop/dotnet/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,13 +159,13 @@ Configure and use the Temporal Observability APIs.
159159

160160
- [Emit Metrics](/develop/dotnet/observability#metrics): Each Temporal SDK is capable of emitting an optional set of
161161
metrics from either the Client or the Worker process.
162-
- [Set up Tracing](/develop/dotnet/observability#tracing): Explains how the Go SDK supports tracing and custom context
162+
- [Set up Tracing](/develop/dotnet/observability#tracing): Explains how the .NET SDK supports tracing and custom context
163163
propagation.
164164
- [Log from a Workflow](/develop/dotnet/observability#logging): Send logs and errors to a logging service, so that when
165165
things go wrong, you can see what happened.
166166
- [Use Visibility APIs](/develop/dotnet/observability#visibility): The term Visibility, within the Temporal Platform,
167167
refers to the subsystems and APIs that enable an operator to view Workflow Executions that currently exist within a
168-
Terminal Service.
168+
Temporal Service.
169169

170170
## [Debugging](/develop/dotnet/debugging)
171171

docs/develop/dotnet/message-passing.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ To send an Update to a Workflow Execution, you can:
320320
wf => wf.SetCurrentLanguageAsync(GreetingWorkflow.Language.Chinese));
321321
```
322322

323-
- 2. Use `StartUpdateAsync` to receive a handle as soon as the Update is accepted.
323+
2. Use `StartUpdateAsync` to receive a handle as soon as the Update is accepted.
324324
It returns an `UpdateHandle`
325325

326326
- Use this `UpdateHandle` later to fetch your results.
@@ -714,7 +714,7 @@ When working with Updates, you may encounter these errors:
714714
- **No Workflow Workers are polling the Task Queue**:
715715
Your request will be retried by the SDK Client indefinitely.
716716
Use a `CancellationToken` in your [RPC options](https://dotnet.temporal.io/api/Temporalio.Client.WorkflowUpdateOptions.html#Temporalio_Client_WorkflowUpdateOptions_Rpc) to cancel the Update.
717-
This raises a [Temporalio.Exceptions.WorkflowUpdateRpcTimeoutOrCanceledException](https://dotnet.temporal.io/api/Temporalio.Exceptions.WorkflowUpdateRpcTimeoutOrCanceledException.html) exception .
717+
This raises a [Temporalio.Exceptions.WorkflowUpdateRpcTimeoutOrCanceledException](https://dotnet.temporal.io/api/Temporalio.Exceptions.WorkflowUpdateRpcTimeoutOrCanceledException.html) exception.
718718
719719
- **Update failed**: You'll receive a [`Temporalio.Exceptions.WorkflowUpdateFailedException`](https://dotnet.temporal.io/api/Temporalio.Exceptions.WorkflowUpdateFailedException.html) exception.
720720
There are two ways this can happen:

docs/develop/dotnet/observability.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,5 +241,5 @@ var myTextAttributeKey = SearchAttributeKey.CreateText("MyTextAttribute");
241241
// Add/Update the keyword one and remove the text one
242242
Workflow.UpsertTypedSearchAttributes(
243243
myKeywordAttributeKey.ValueSet("SomeKeywordValue"),
244-
myTextAttrbiuteKey.ValueUnset());
244+
myTextAttributeKey.ValueUnset());
245245
```

docs/develop/dotnet/schedules.mdx

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

3232
**How to Schedule a Workflow using the Temporal .NET SDK**
3333

34-
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
34+
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.
3535

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

3838
### Create a Scheduled Workflow {#create-a-workflow}
3939

docs/develop/dotnet/temporal-client.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ public static class LoadFromFile
438438

439439
<TabItem value="code" label="Code">
440440

441-
You can also provide connections options in your Go code directly. To create an initial connection, provide the
441+
You can also provide connections options in your .NET code directly. To create an initial connection, provide the
442442
Namespace and API key values to the ` TemporalClient.ConnectAsync` method.
443443

444444
```csharp

docs/develop/dotnet/temporal-nexus.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ See the [Nexus cancellation sample](https://github.com/temporalio/samples-dotnet
396396

397397
## Make Nexus calls across Namespaces in Temporal Cloud {#nexus-calls-across-namespaces-temporal-cloud}
398398

399-
This section assumes you are already familiar with how to connect a Worker to Temporal Cloud.
399+
This section assumes you are already familiar with how to connect a Worker to Temporal Cloud.
400400
The `tcld` CLI is used to create Namespaces and the Nexus Endpoint, and mTLS client certificates will be used to securely connect the caller and handler Workers to their respective Temporal Cloud Namespaces.
401401

402402
### Install the latest `tcld` CLI and generate certificates

docs/develop/php/asynchronous-activity-completion.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Calling `yield` on promise blocks until a result is available.
3232
> Activity promise also exposes `then` method to construct promise chains.
3333
> Read more about Promises [here](https://github.com/reactphp/promise).
3434
35-
Alternatively you can explicitly wrap your code (including `yield` constucts) using `Workflow::async` which will execute nested code in parallel with main Workflow code.
36-
Call `yeild` on Promise returned by `Workflow::async` to merge execution result back to primary Workflow method.
35+
Alternatively you can explicitly wrap your code (including `yield` constructs) using `Workflow::async` which will execute nested code in parallel with main Workflow code.
36+
Call `yield` on Promise returned by `Workflow::async` to merge execution result back to primary Workflow method.
3737

3838
```php
3939
public function greet(string $name): \Generator

0 commit comments

Comments
 (0)