Conversation
…own-validations # Conflicts: # CHANGELOG.md
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Fixes Markdown formatting and linting issues across the repository documentation so that pymarkdown rules pass and the docs render more consistently.
Changes:
- Reflowed long lines and reformatted lists/code blocks for Markdown linter compliance.
- Normalized heading levels and section structure in various docs.
- Improved readability of boilerplate/support/security markdown content.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 15 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/sub-orchestrations-with-fan-out-fan-in/README.md | Rewrapped text, adjusted headings/lists, and clarified running steps. |
| durabletask-azuremanaged/CHANGELOG.md | Reflowed long lines and nested bullets for changelog readability. |
| docs/supported-patterns.md | Adjusted heading levels and rewrapped sections describing supported orchestration patterns. |
| docs/getting-started.md | Updated headings and wrapped links/list items for linting and readability. |
| docs/features.md | Reformatted feature documentation sections, lists, and code samples for linting. |
| docs/development.md | Rewrapped paragraphs and fixed Markdown formatting in dev instructions. |
| SUPPORT.md | Converted placeholder into a warning block and reflowed content. |
| SECURITY.md | Added top-level heading, renamed section, and reflowed template text/lists. |
| README.md | Reflowed badges/paragraphs and normalized “References” heading. |
| CONTRIBUTING.md | Wrapped long lines and converted raw URL into a proper Markdown link. |
| CHANGELOG.md | Reflowed entries and wrapped long bullets/links for consistency. |
| The following orchestration patterns are currently supported. | ||
|
|
||
| ### Function chaining | ||
| ## Function chaining |
There was a problem hiding this comment.
Heading hierarchy is inconsistent: only 'Function chaining' was promoted to ## while the other peer sections remain ###. This likely breaks heading structure (and can trigger heading-level lint rules). Make the other pattern section headings consistent (e.g., all ## under the top-level # Supported patterns).
| @@ -24,7 +24,8 @@ See the full [function chaining example](../examples/activity_sequence.py). | |||
|
|
|||
| ### Fan-out/fan-in | |||
There was a problem hiding this comment.
Heading hierarchy is inconsistent: only 'Function chaining' was promoted to ## while the other peer sections remain ###. This likely breaks heading structure (and can trigger heading-level lint rules). Make the other pattern section headings consistent (e.g., all ## under the top-level # Supported patterns).
| @@ -52,7 +53,9 @@ See the full [fan-out sample](../examples/fanout_fanin.py). | |||
|
|
|||
| ### Human interaction and durable timers | |||
There was a problem hiding this comment.
Heading hierarchy is inconsistent: only 'Function chaining' was promoted to ## while the other peer sections remain ###. This likely breaks heading structure (and can trigger heading-level lint rules). Make the other pattern section headings consistent (e.g., all ## under the top-level # Supported patterns).
|
|
||
| See the full [human interaction sample](../examples/human_interaction.py). | ||
|
|
||
| ### Version-aware orchestrator |
There was a problem hiding this comment.
Heading hierarchy is inconsistent: only 'Function chaining' was promoted to ## while the other peer sections remain ###. This likely breaks heading structure (and can trigger heading-level lint rules). Make the other pattern section headings consistent (e.g., all ## under the top-level # Supported patterns).
|
|
||
| ### Run the Order Processing Example | ||
| - Check out the [Durable Task Scheduler example](../examples/dts/sub-orchestrations-with-fan-out-fan-in/README.md) | ||
| ## Run the Order Processing Example |
There was a problem hiding this comment.
Explore Other Samples is now a level-3 heading (###) while Run the Order Processing Example is level-2 (##). If these are intended as sibling sections under # Getting Started, they should be the same level (typically both ##).
| ##### Locking and concurrency | ||
|
|
||
| Because entites 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: | ||
| Because entites can be accessed from multiple running orchestrations at the same time, entities may |
There was a problem hiding this comment.
Correct typo: 'entites' should be 'entities'.
| 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 |
| ##### Deleting entities | ||
|
|
||
| Entites 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 entity with the "delete" operation. In this SDK, we provide a default implementation for the "delete" operation to clear the state when using class-based entities, which end users are free to override as needed. Users must implement "delete" manually for function-based entities. | ||
| Entites are represented as orchestration instances in your Task Hub, and their state is persisted in |
There was a problem hiding this comment.
Correct typo/capitalization: 'Entites' should be 'Entities'.
| 1. Install Docker: If it is not already installed. | ||
|
|
||
| 2. Pull the Docker Image for the Emulator: |
There was a problem hiding this comment.
The ordered list numbering is inconsistent within the same sequence (1, 2, then back to 1, 1). Even if Markdown renderers auto-number, this is confusing in raw text and can trip list-style linting depending on configuration. Consider using either strictly increasing numbers (1–4) or 1. for every item consistently.
| ``` | ||
|
|
||
| 3. Run the Emulator: Wait a few seconds for the container to be ready. | ||
| 1. Run the Emulator: Wait a few seconds for the container to be ready. |
There was a problem hiding this comment.
The ordered list numbering is inconsistent within the same sequence (1, 2, then back to 1, 1). Even if Markdown renderers auto-number, this is confusing in raw text and can trip list-style linting depending on configuration. Consider using either strictly increasing numbers (1–4) or 1. for every item consistently.
| ``` | ||
|
|
||
| 4. Install the Required Packages: | ||
| 1. Install the Required Packages: |
There was a problem hiding this comment.
The ordered list numbering is inconsistent within the same sequence (1, 2, then back to 1, 1). Even if Markdown renderers auto-number, this is confusing in raw text and can trip list-style linting depending on configuration. Consider using either strictly increasing numbers (1–4) or 1. for every item consistently.
Fixes a number of markdown syntax/rules issues in .md files across the repos - pymarkdown linting now passes on all files