Add README.md for Polly.Core #1060
Conversation
| } | ||
| ``` | ||
|
|
||
| The `ResilienceStrategy` unifies the 4 different policies used now in Polly. User actions are executed under a single API. The are many methods |
There was a problem hiding this comment.
I think we have more than four in total. Maybe just say "many" or "various"?
| context.IsSynchronous = true; | ||
| context.IsVoid = true; | ||
| context.ResultType = typeof(VoidResult); |
There was a problem hiding this comment.
In a follow-up PR, I wonder if we should integrate something like MarkdownSnippets.Tool into the repo and have real working/compilable samples in the test project that can auto-generate so these things are easy to keep up-to-date and working as v8 gets implemented?
There was a problem hiding this comment.
Looks really nice and it would help to keep the docs in sync with the code. Love the idea.
Fyi, we are also using docfx that supports the similar thing such as referencing snippets from the code using regions:
https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet#code-snippet
I'll go ahead and merge this and we address this in follow-up.
The issue or feature being addressed
Here we are just adding README.md for
Polly.Coreproject that adds technical details for contributors. This file is just transferred from v8-poc branch and updated with the latest API.Details on the issue fix or feature implementation
Confirm the following