Add the v8 README.md #1548
Merged
Add the v8 README.md #1548
Conversation
This file contains 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
martintmk
force-pushed
the
documentation-v8
branch
2 times, most recently
from
5cdf5bc
to
32f9cf8
Compare
|
cc @peter-csala if you are interested, your feedback is greatly appreactiated too. |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #1548 +/- ##
=======================================
Coverage 83.92% 83.92%
=======================================
Files 279 279
Lines 6518 6518
Branches 1017 1017
=======================================
Hits 5470 5470
Misses 839 839
Partials 209 209
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
martintmk
force-pushed
the
documentation-v8
branch
3 times, most recently
from
0f1a346
to
729e40a
Compare
martintmk
force-pushed
the
documentation-v8
branch
7 times, most recently
from
290f228
to
b9e4d86
Compare
martintmk
force-pushed
the
documentation-v8
branch
from
0995e5d
to
c269fc9
Compare
docs/general.md
Outdated
|
|
||
| ## Supported targets | ||
|
|
||
| Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2. |
There was a problem hiding this comment.
Suggested change
| Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2. | |
| Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2. |
docs/general.md
Outdated
|
|
||
| ## Supported targets | ||
|
|
||
| Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2. |
README_V8.md
Outdated
| ``` | ||
| <!-- endSnippet --> | ||
|
|
||
| If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry). |
There was a problem hiding this comment.
Suggested change
| If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry). | |
| If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more details visit the [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry). |
README_V8.md
Outdated
| ``` | ||
| <!-- endSnippet --> | ||
|
|
||
| If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry). |
There was a problem hiding this comment.
Should this point to a newer stub too? Similar comments throughout this file to avoid linking to the Wiki in these new files.
There was a problem hiding this comment.
Will update these in follow-up
martincostello
approved these changes
Sep 6, 2023
src/Snippets/Docs/Hedging.cs
Outdated
| new ResiliencePipelineBuilder<HttpResponseMessage>() | ||
| .AddHedging(new HedgingStrategyOptions<HttpResponseMessage>()); | ||
|
|
||
| // Add a customized hedging strategy that retries up to 3 times if the execution | ||
| // takes longer than 1 second or if it fails due to an exception | ||
| // or returns a 500 Internal Server Error. | ||
| // takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error. |
There was a problem hiding this comment.
Suggested change
| // takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error. | |
| // takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Details on the issue fix or feature implementation
README_V8.mdthat describes v8 API.Compared to v7
README.mdthe new one is much leaner with more beefier sections extracted into separate documents. Some docs are still missing or incomplete, I'll address these in follow-up PRs to not make this one huge.Contributes to #1091
Confirm the following