[Docs] Small cleanup and improvements #1782
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1782 +/- ##
=======================================
Coverage 84.56% 84.56%
=======================================
Files 308 308
Lines 6791 6791
Branches 1044 1044
=======================================
Hits 5743 5743
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. |
|
|
||
| Over the years, many developers have used Polly in various ways. Some of these | ||
| recurring patterns may not be ideal. This section highlights the recommended practices | ||
| and those to avoid. | ||
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. |
There was a problem hiding this comment.
Suggested change
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |
| recurring patterns may not be ideal. The sections below highlight anti-patterns to avoid. |
docs/strategies/circuit-breaker.md
Outdated
| @@ -306,7 +306,8 @@ sequenceDiagram | |||
|
|
|||
| ## Anti-patterns | |||
|
|
|||
| Over the years, many developers have used Polly in various ways. Some of these recurring patterns may not be ideal. This section highlights the recommended practices and those to avoid. | |||
| Over the years, many developers have used Polly in various ways. Some of these | |||
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |||
There was a problem hiding this comment.
Suggested change
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |
| recurring patterns may not be ideal. The sections below highlight anti-patterns to avoid. |
docs/strategies/fallback.md
Outdated
| @@ -154,7 +154,8 @@ Here's a breakdown of the behavior when the callback produces either an `HttpSta | |||
|
|
|||
| ## Anti-patterns | |||
|
|
|||
| Over the years, many developers have used Polly in various ways. Some of these recurring patterns may not be ideal. This section highlights the recommended practices and ones to avoid. | |||
| Over the years, many developers have used Polly in various ways. Some of these | |||
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |||
There was a problem hiding this comment.
Suggested change
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |
| recurring patterns may not be ideal. The sections below highlight anti-patterns to avoid. |
docs/strategies/retry.md
Outdated
| @@ -200,7 +200,8 @@ while (!cancellationToken.IsCancellationRequested) | |||
|
|
|||
| ## Anti-patterns | |||
|
|
|||
| Over the years, many developers have used Polly in various ways. Some of these recurring patterns may not be ideal. This section highlights the recommended practices and those to avoid. | |||
| Over the years, many developers have used Polly in various ways. Some of these | |||
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |||
There was a problem hiding this comment.
Suggested change
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |
| recurring patterns may not be ideal. The sections below highlight anti-patterns to avoid. |
docs/strategies/timeout.md
Outdated
| @@ -127,6 +127,9 @@ sequenceDiagram | |||
|
|
|||
| ## Anti-patterns | |||
|
|
|||
| Over the years, many developers have used Polly in various ways. Some of these | |||
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |||
There was a problem hiding this comment.
Suggested change
| recurring patterns may not be ideal. The sections bellow highlights anti-patterns to avoid. | |
| recurring patterns may not be ideal. The sections below highlight anti-patterns to avoid. |
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
Just some docs cleanup.
Confirm the following