Skip to content

Commit

Permalink
Emphasize that it never returns
Browse files Browse the repository at this point in the history
  • Loading branch information
A5rocks authored Oct 20, 2024
1 parent 373be41 commit 1c94d82
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/trio/_timeouts.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ def move_on_after(
async def sleep_forever() -> NoReturn:
"""Pause execution of the current task forever (or until cancelled).
Equivalent to calling ``await sleep(math.inf)``, except that instead of
returning this will raise a `RuntimeError`.
Equivalent to calling ``await sleep(math.inf)``, except that if manually
rescheduled this will raise a `RuntimeError`.
Raises:
RuntimeError: if rescheduled
Expand Down

0 comments on commit 1c94d82

Please sign in to comment.