diff --git a/docs/source/history.rst b/docs/source/history.rst index 3936df867e..a8fd584675 100644 --- a/docs/source/history.rst +++ b/docs/source/history.rst @@ -232,9 +232,9 @@ Bugfixes - On Ubuntu systems, the system Python includes a custom unhandled-exception hook to perform `crash reporting `__. Unfortunately, Trio wants to use - the same hook to print nice `MultiError` tracebacks, causing a + the same hook to print nice ``MultiError`` tracebacks, causing a conflict. Previously, Trio would detect the conflict, print a warning, - and you just wouldn't get nice `MultiError` tracebacks. Now, Trio has + and you just wouldn't get nice ``MultiError`` tracebacks. Now, Trio has gotten clever enough to integrate its hook with Ubuntu's, so the two systems should Just Work together. (`#1065 `__) - Fixed an over-strict test that caused failures on Alpine Linux. @@ -436,7 +436,7 @@ Features violated. (One common source of such violations is an async generator that yields within a cancel scope.) The previous behavior was an inscrutable chain of TrioInternalErrors. (`#882 `__) -- MultiError now defines its ``exceptions`` attribute in ``__init__()`` +- ``MultiError`` now defines its ``exceptions`` attribute in ``__init__()`` to better support linters and code autocompletion. (`#1066 `__) - Use ``__slots__`` in more places internally, which should make Trio slightly faster. (`#984 `__) @@ -457,7 +457,7 @@ Bugfixes :meth:`~trio.Path.cwd`, are now async functions. Previously, a bug in the forwarding logic meant :meth:`~trio.Path.cwd` was synchronous and :meth:`~trio.Path.home` didn't work at all. (`#960 `__) -- An exception encapsulated within a :class:`MultiError` doesn't need to be +- An exception encapsulated within a `MultiError` doesn't need to be hashable anymore. .. note:: @@ -1248,7 +1248,7 @@ Other changes interfering with direct use of :func:`~trio.testing.wait_all_tasks_blocked` in the same test. -* :meth:`MultiError.catch` now correctly preserves ``__context__``, +* ``MultiError.catch()`` now correctly preserves ``__context__``, despite Python's best attempts to stop us (`#165 `__) diff --git a/docs/source/reference-core.rst b/docs/source/reference-core.rst index e320088cf8..658e14d08e 100644 --- a/docs/source/reference-core.rst +++ b/docs/source/reference-core.rst @@ -641,7 +641,7 @@ crucial things to keep in mind: * Any unhandled exceptions are re-raised inside the parent task. If there are multiple exceptions, then they're collected up into a - single :exc:`BaseExceptionGroup` or :exc:`ExceptionGroup` exception. + single ``BaseExceptionGroup`` or ``ExceptionGroup`` exception. Since all tasks are descendents of the initial task, one consequence of this is that :func:`run` can't finish until all tasks have @@ -712,9 +712,9 @@ limitation. Consider code like:: what? In some sense, the answer should be "both of these at once", but in Python there can only be one exception at a time. -Trio's answer is that it raises a :exc:`BaseExceptionGroup` object. This is a +Trio's answer is that it raises a ``BaseExceptionGroup`` object. This is a special exception which encapsulates multiple exception objects – -either regular exceptions or nested :exc:`BaseExceptionGroup`\s. +either regular exceptions or nested ``BaseExceptionGroup``\s. Spawning tasks without becoming a parent