-
Notifications
You must be signed in to change notification settings - Fork 25
Cleanup markdown errors #131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
andystaples
wants to merge
3
commits into
microsoft:main
Choose a base branch
from
andystaples:andystaples/fix-markdown-validations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,47 @@ | ||
| # Durable Task SDK for Python | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml) | ||
| [](https://badge.fury.io/py/durabletask) | ||
|
|
||
| This repo contains a Python SDK for use with the [Azure Durable Task Scheduler](https://github.com/Azure/Durable-Task-Scheduler). With this SDK, you can define, schedule, and manage durable orchestrations using ordinary Python code. | ||
| This repo contains a Python SDK for use with the [Azure Durable Task | ||
| Scheduler](https://github.com/Azure/Durable-Task-Scheduler). With this SDK, you can define, | ||
| schedule, and manage durable orchestrations using ordinary Python code. | ||
|
|
||
| > Note that this SDK is **not** currently compatible with [Azure Durable Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview). If you are looking for a Python SDK for Azure Durable Functions, please see [this repo](https://github.com/Azure/azure-functions-durable-python). | ||
| > Note that this SDK is **not** currently compatible with [Azure Durable | ||
| Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview). If | ||
| you are looking for a Python SDK for Azure Durable Functions, please see [this | ||
| repo](https://github.com/Azure/azure-functions-durable-python). | ||
|
|
||
| ## References | ||
|
|
||
| # References | ||
| - [Supported Patterns](./docs/supported-patterns.md) | ||
| - [Available Features](./docs/features.md) | ||
| - [Getting Started](./docs/getting-started.md) | ||
| - [Development Guide](./docs/development.md) | ||
| - [Development Guide](./docs/development.md) | ||
| - [Contributing Guide](./CONTRIBUTING.md) | ||
|
|
||
| ## Optional Features | ||
|
|
||
| ### Large Payload Externalization | ||
|
|
||
| Install the `azure-blob-payloads` extra to automatically offload | ||
| oversized orchestration payloads to Azure Blob Storage: | ||
| Install the `azure-blob-payloads` extra to automatically offload oversized orchestration payloads to | ||
| Azure Blob Storage: | ||
|
|
||
| ```bash | ||
| pip install durabletask[azure-blob-payloads] | ||
| ``` | ||
|
|
||
| See the [feature documentation](./docs/features.md#large-payload-externalization) | ||
| and the [example](./examples/large_payload/) for usage details. | ||
| See the [feature documentation](./docs/features.md#large-payload-externalization) and the | ||
| [example](./examples/large_payload/) for usage details. | ||
|
|
||
| ## Trademarks | ||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft | ||
| trademarks or logos is subject to and must follow | ||
| [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). | ||
| Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. | ||
| Any use of third-party trademarks or logos are subject to those third-party's policies. | ||
|
|
||
| This project may contain trademarks or logos for projects, products, or services. Authorized use of | ||
| Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand | ||
| Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). | ||
| Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion | ||
| or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those | ||
| third-party's policies. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,60 @@ | ||
| # Security | ||
|
|
||
| <!-- BEGIN MICROSOFT SECURITY.MD V0.0.8 BLOCK --> | ||
|
|
||
| ## Security | ||
| ## Overview | ||
|
|
||
| Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). | ||
| Microsoft takes the security of our software products and services seriously, which includes all | ||
| source code repositories managed through our GitHub organizations, which include | ||
| [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), | ||
| [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), | ||
| [Xamarin](https://github.com/xamarin), and [our GitHub | ||
| organizations](https://opensource.microsoft.com/). | ||
|
|
||
| If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below. | ||
| If you believe you have found a security vulnerability in any Microsoft-owned repository that meets | ||
| [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), | ||
| please report it to us as described below. | ||
|
|
||
| ## Reporting Security Issues | ||
|
|
||
| **Please do not report security vulnerabilities through public GitHub issues.** | ||
|
|
||
| Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). | ||
| Instead, please report them to the Microsoft Security Response Center (MSRC) at | ||
| [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report). | ||
|
|
||
| If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey). | ||
| If you prefer to submit without logging in, send email to | ||
| [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP | ||
| key; please download it from the [Microsoft Security Response Center PGP Key | ||
| page](https://aka.ms/opensource/security/pgpkey). | ||
|
|
||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). | ||
| You should receive a response within 24 hours. If for some reason you do not, please follow up via | ||
| email to ensure we received your original message. Additional information can be found at | ||
| [microsoft.com/msrc](https://aka.ms/opensource/security/msrc). | ||
|
|
||
| Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: | ||
| Please include the requested information listed below (as much as you can provide) to help us better | ||
| understand the nature and scope of the possible issue: | ||
|
|
||
| * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) | ||
| * Full paths of source file(s) related to the manifestation of the issue | ||
| * The location of the affected source code (tag/branch/commit or direct URL) | ||
| * Any special configuration required to reproduce the issue | ||
| * Step-by-step instructions to reproduce the issue | ||
| * Proof-of-concept or exploit code (if possible) | ||
| * Impact of the issue, including how an attacker might exploit the issue | ||
| * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) | ||
| * Full paths of source file(s) related to the manifestation of the issue | ||
| * The location of the affected source code (tag/branch/commit or direct URL) | ||
| * Any special configuration required to reproduce the issue | ||
| * Step-by-step instructions to reproduce the issue | ||
| * Proof-of-concept or exploit code (if possible) | ||
| * Impact of the issue, including how an attacker might exploit the issue | ||
|
|
||
| This information will help us triage your report more quickly. | ||
|
|
||
| If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs. | ||
| If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty | ||
| award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) | ||
| page for more details about our active programs. | ||
|
|
||
| ## Preferred Languages | ||
|
|
||
| We prefer all communications to be in English. | ||
|
|
||
| ## Policy | ||
|
|
||
| Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd). | ||
| Microsoft follows the principle of [Coordinated Vulnerability | ||
| Disclosure](https://aka.ms/opensource/security/cvd). | ||
|
|
||
| <!-- END MICROSOFT SECURITY.MD BLOCK --> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changelog entry contains broken Markdown link syntax and unbalanced parentheses (
[@berndverst)(...)and the([#38](...)segment missing a closing)). This will render incorrectly and should be corrected to valid link/parenthesis formatting.