Skip to content

Commit

Permalink
📝 Document the raising of ExceptionGroup when a task errors out
Browse files Browse the repository at this point in the history
Mention PEP0654 so that people know what an ExceptionGroup is, and how it could be handled.
  • Loading branch information
weiji14 committed Aug 3, 2023
1 parent 282bb26 commit d2482e9
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions bambooflow/datapipes/callable.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ class MapperAsyncIterDataPipe(AsyncIterDataPipe):
An :py-term:`awaitable` object from the
:py-term:`asynchronous iterator <asynchronous-iterator>`.
Raises
------
ExceptionGroup
If any one of the concurrent tasks raises an :py:class:`Exception`. See
`PEP654 <https://peps.python.org/pep-0654/#handling-exception-groups>`_
for general advice on how to handle exception groups.
Example
-------
>>> import asyncio
Expand Down

0 comments on commit d2482e9

Please sign in to comment.