[Docs] Improve diagrams for hedging cancellation #1975
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
martincostello
approved these changes
Feb 19, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1975 +/- ##
=======================================
Coverage 83.64% 83.64%
=======================================
Files 312 312
Lines 7106 7106
Branches 1056 1056
=======================================
Hits 5944 5944
Misses 789 789
Partials 373 373
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Do you want to extend these as well:
cc: @martintmk |
peter-csala
approved these changes
Feb 19, 2024
docs/strategies/timeout.md
Outdated
| T->>P: Throws <br/>TimeoutRejectedException | ||
| P->>C: Propagates exception | ||
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > Notice that the timeout waits until the callback is cancelled before throwing `TimeoutRejectedException`. Therefore it's important for the callbacks to respect the cancellation token passed to the execution. If the cancellation token is not correctly respected, the timeout is unnecessarily delayed. |
There was a problem hiding this comment.
Suggested change
| > Notice that the timeout waits until the callback is cancelled before throwing `TimeoutRejectedException`. Therefore it's important for the callbacks to respect the cancellation token passed to the execution. If the cancellation token is not correctly respected, the timeout is unnecessarily delayed. | |
| > Notice that the timeout waits until the callback is cancelled before throwing `TimeoutRejectedException`. Therefore it's important for the callbacks to respect the cancellation token passed to the execution. If the cancellation token is not correctly respected, the timeout is unnecessarily delayed. |
There was a problem hiding this comment.
Just wondering: If we use Therefore it's important wording inside the note then would it make sense to use [!IMPORTANT] instead?
There was a problem hiding this comment.
Sure makes sense, changed to important.
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
The cancellation behavior was not fully described, this PR fixes this:
Confirm the following