feat(generator): separate page for retry policy overrides #11950
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 ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #11950 +/- ##
==========================================
- Coverage 93.67% 93.66% -0.01%
==========================================
Files 1838 1838
Lines 166749 166763 +14
==========================================
+ Hits 156195 156203 +8
- Misses 10554 10560 +6
☔ View full report in Codecov by Sentry. |
dbolduc
reviewed
Jun 22, 2023
| void GenerateOverrideRetryPoliciesPage( | ||
| std::ostream& os, std::map<std::string, std::string> const& variables) { | ||
| auto constexpr kText = R"""(/*! | ||
| @page $library$-override-retry Override Retry, Backof, and Idempotency Policies |
| You can provide your own class for this option. The library also provides two | ||
| built-in policies: | ||
|
|
||
| - `*LimitedErrorCountRetryPolicy`: stops retrying after an specified number |
|
|
||
| - `*LimitedErrorCountRetryPolicy`: stops retrying after an specified number | ||
| of transient errors. | ||
| - `*LimitedTimeRetryPolicy`: stops retrying after an specified time. |
Comment on lines
876
to
877
| Note that a library may have more than one version of these classes. Their name | ||
| matches the `*Client` and `*Connection` object they are intended to be used |
There was a problem hiding this comment.
s/Their name matches/Their names match/
| backoff. The current backoff is doubled after each failure, but never exceeds | ||
| (or is "truncated") if it reaches a prescribed maximum. | ||
|
|
||
| @section $library$-override-retry-idempotency-policy Controlling the which operations are retryable |
| GenerateOverrideRetryPoliciesPage(os, vars); | ||
| auto const actual = std::move(os).str(); | ||
| EXPECT_THAT(actual, AllOf(HasSubstr(R"""( | ||
| @page test-override-retry Override Retry, Backof, and Idempotency Policies |
|
PTAL |
dbolduc
approved these changes
Jun 23, 2023
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.
Part of the work for #10157
This change is