PR Feedback

Author: andystaples

CHANGELOG.md

@@ -144,8 +144,8 @@ CHANGED
   [@berndverst](https://github.com/berndverst)
 - Http and grpc protocols and their secure variants are stripped from the host name parameter if
   provided. Secure mode is enabled if the protocol provided is https or grpcs
-  ([#38](https://github.com/microsoft/durabletask-python/pull/38) - by
-  [@berndverst)(https://github.com/berndverst)
+  ([#38](https://github.com/microsoft/durabletask-python/pull/38)) - by
+  [@berndverst](https://github.com/berndverst)
 - Improve ProtoGen by downloading proto file directly instead of using submodule
   ([#39](https://github.com/microsoft/durabletask-python/pull/39) - by
   [@berndverst](https://github.com/berndverst)

docs/features.md

@@ -175,7 +175,7 @@ Entities can perform actions such signaling other entities or starting new orche
 
 ##### Locking and concurrency
 
-Because entites can be accessed from multiple running orchestrations at the same time, entities may
+Because entities can be accessed from multiple running orchestrations at the same time, entities may
 also be locked by a single orchestrator ensuring exclusive access during the duration of the lock
 (also known as a critical section). Think semaphores:
 
@@ -191,7 +191,7 @@ details and advanced usage, see the examples and API documentation.
 
 ##### Deleting entities
 
-Entites are represented as orchestration instances in your Task Hub, and their state is persisted in
+Entities are represented as orchestration instances in your Task Hub, and their state is persisted in
 the Task Hub as well. When using the Durable Task Scheduler as your durability provider, the backend
 will automatically clean up entities when their state is empty, this is effectively the "delete"
 operation to save space in the Task Hub. In the DTS Dashboard, "delete entity" simply signals the

docs/getting-started.md

@@ -6,7 +6,7 @@
   example](../examples/dts/sub-orchestrations-with-fan-out-fan-in/README.md)
  for detailed instructions on running the order processing example.
 
-### Explore Other Samples
+## Explore Other Samples
 
 - Visit the [examples](../examples/dts/) directory to find a variety of sample orchestrations and
   learn how to run them.

docs/supported-patterns.md

@@ -22,7 +22,7 @@ def sequence(ctx: task.OrchestrationContext, _):
 
 See the full [function chaining example](../examples/activity_sequence.py).
 
-### Fan-out/fan-in
+## Fan-out/fan-in
 
 An orchestration can fan-out a dynamic number of function calls in parallel and then fan-in the
 results using the following syntax:
@@ -51,9 +51,9 @@ def orchestrator(ctx: task.OrchestrationContext, _):
 
 See the full [fan-out sample](../examples/fanout_fanin.py).
 
-### Human interaction and durable timers
+## Human interaction and durable timers
 
-An orchestration can wait for a user-defined event, such as a human approval event, before proceding
+An orchestration can wait for a user-defined event, such as a human approval event, before proceeding
 to the next step. In addition, the orchestration can create a timer with an arbitrary duration that
 triggers some alternate action if the external event hasn't been received:
 
@@ -87,7 +87,7 @@ automatically by the SDK.
 
 See the full [human interaction sample](../examples/human_interaction.py).
 
-### Version-aware orchestrator
+## Version-aware orchestrator
 
 When utilizing orchestration versioning, it is possible for an orchestrator to remain
 backwards-compatible with orchestrations created using the previously defined version. For instance,
@@ -104,7 +104,7 @@ def my_orchestrator(ctx: task.OrchestrationContext, order: Order):
 Assume that any orchestrations created using this orchestrator were versioned 1.0.0. If the
 signature of this method needs to be updated to call activity_three between the calls to
 activity_one and activity_two, ordinarily this would break any running orchestrations at the time of
-deployment. However, the following orchestrator will be able to process both orchestraions versioned
+deployment. However, the following orchestrator will be able to process both orchestrations versioned
 1.0.0 and 2.0.0 after the change:
 
 ```python
@@ -132,7 +132,7 @@ def my_orchestrator(ctx: task.OrchestrationContext, order: Order):
 
 See the full [version-aware orchestrator sample](../examples/version_aware_orchestrator.py)
 
-### Work item filtering
+## Work item filtering
 
 When running multiple workers against the same task hub, each worker can declare which work items it
 handles. The backend then dispatches only the matching orchestrations, activities, and entities,
@@ -173,7 +173,7 @@ w.use_work_item_filters(WorkItemFilters(
 
 See the full [work item filtering sample](../examples/work_item_filtering.py).
 
-### Large payload externalization
+## Large payload externalization
 
 When orchestrations work with very large inputs, outputs, or event data, the payloads can exceed
 gRPC message size limits. The large payload externalization pattern transparently offloads these

examples/sub-orchestrations-with-fan-out-fan-in/README.md

@@ -35,21 +35,21 @@ easy-to-use Docker container.
 
 2. Pull the Docker Image for the Emulator:
 
-```bash
-docker pull mcr.microsoft.com/dts/dts-emulator:v0.0.6
-```
+    ```bash
+    docker pull mcr.microsoft.com/dts/dts-emulator:v0.0.6
+    ```
 
-1. Run the Emulator: Wait a few seconds for the container to be ready.
+3. Run the Emulator: Wait a few seconds for the container to be ready.
 
-```bash
-docker run --name dtsemulator -d -p 8080:8080 mcr.microsoft.com/dts/dts-emulator:v0.0.6
-```
+    ```bash
+    docker run --name dtsemulator -d -p 8080:8080 mcr.microsoft.com/dts/dts-emulator:v0.0.6
+    ```
 
-1. Install the Required Packages:
+4. Install the Required Packages:
 
-```bash
-pip install -r requirements.txt
-```
+    ```bash
+    pip install -r requirements.txt
+    ```
 
 Note: The example code has been updated to use the default emulator settings automatically
 (endpoint: [http://localhost:8080](http://localhost:8080), taskhub: default). You don't need to set
@@ -62,43 +62,43 @@ Azure CLI:
 
 1. Create a Scheduler:
 
-```bash
-az durabletask scheduler create --resource-group <testrg> \
-  --name <testscheduler> \
-  --location <eastus> --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1 \
-  --sku-name "Dedicated" --tags "{'myattribute':'myvalue'}"
-```
+    ```bash
+    az durabletask scheduler create --resource-group <testrg> \
+      --name <testscheduler> \
+      --location <eastus> --ip-allowlist "[0.0.0.0/0]" --sku-capacity 1 \
+      --sku-name "Dedicated" --tags "{'myattribute':'myvalue'}"
+    ```
 
-1. Create Your Taskhub:
+2. Create Your Taskhub:
 
-```bash
-az durabletask taskhub create --resource-group <testrg> \
-  --scheduler-name <testscheduler> --name <testtaskhub>
-```
+    ```bash
+    az durabletask taskhub create --resource-group <testrg> \
+      --scheduler-name <testscheduler> --name <testtaskhub>
+    ```
 
-1. Retrieve the Endpoint for the Scheduler: Locate the taskhub in the Azure portal to find the
+3. Retrieve the Endpoint for the Scheduler: Locate the taskhub in the Azure portal to find the
    endpoint.
 
-2. Set the Environment Variables:
-Bash:
+4. Set the Environment Variables:
+   Bash:
 
-```bash
-export TASKHUB=<taskhubname>
-export ENDPOINT=<taskhubEndpoint>
-```
+   ```bash
+   export TASKHUB=<taskhubname>
+   export ENDPOINT=<taskhubEndpoint>
+   ```
 
-Powershell:
+   PowerShell:
 
-```powershell
-$env:TASKHUB = "<taskhubname>"
-$env:ENDPOINT = "<taskhubEndpoint>"
-```
+   ```powershell
+   $env:TASKHUB = "<taskhubname>"
+   $env:ENDPOINT = "<taskhubEndpoint>"
+   ```
 
-1. Install the Required Packages:
+5. Install the Required Packages:
 
-```bash
-pip install -r requirements.txt
-```
+    ```bash
+    pip install -r requirements.txt
+    ```
 
 ### Running the Python Components
 
@@ -123,7 +123,7 @@ You should start seeing logs for processing orders in both shell outputs.
 
 To access the Durable Task Scheduler Dashboard, follow these steps:
 
-- **Using the Emulator**: By default, the dashboard runs on portal 8082.
+- **Using the Emulator**: By default, the dashboard runs on port 8082.
   Navigate to [http://localhost:8082](http://localhost:8082) and click on the default task hub.
 
 - **Using a Deployed Scheduler**: Navigate to the Scheduler resource. Then, go to the Task Hub