Document that trio.sleep_forever will raise RuntimeError instead of returning
#3115
Conversation
This file contains hidden or 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 #3115 +/- ##
===================================================
+ Coverage 99.58694% 99.59632% +0.00938%
===================================================
Files 121 121
Lines 18157 18827 +670
Branches 3272 3517 +245
===================================================
+ Hits 18082 18751 +669
- Misses 52 53 +1
Partials 23 23
|
Contributor
|
I don't think this should say "instead of returning", it won't do so in normal usage, it'll only return if cancelled. Better to say that it never returns, and raises |
CoolCat467
approved these changes
Oct 21, 2024
richardsheridan
approved these changes
Oct 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Fixes #3113.