Skip to content

Commit 21757c8

Browse files
committed
Fixed dangling references in the documentation
1 parent 9ecca9b commit 21757c8

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/source/history.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -232,9 +232,9 @@ Bugfixes
232232
- On Ubuntu systems, the system Python includes a custom
233233
unhandled-exception hook to perform `crash reporting
234234
<https://wiki.ubuntu.com/Apport>`__. Unfortunately, Trio wants to use
235-
the same hook to print nice `MultiError` tracebacks, causing a
235+
the same hook to print nice ``MultiError`` tracebacks, causing a
236236
conflict. Previously, Trio would detect the conflict, print a warning,
237-
and you just wouldn't get nice `MultiError` tracebacks. Now, Trio has
237+
and you just wouldn't get nice ``MultiError`` tracebacks. Now, Trio has
238238
gotten clever enough to integrate its hook with Ubuntu's, so the two
239239
systems should Just Work together. (`#1065 <https://github.com/python-trio/trio/issues/1065>`__)
240240
- Fixed an over-strict test that caused failures on Alpine Linux.
@@ -436,7 +436,7 @@ Features
436436
violated. (One common source of such violations is an async generator
437437
that yields within a cancel scope.) The previous behavior was an
438438
inscrutable chain of TrioInternalErrors. (`#882 <https://github.com/python-trio/trio/issues/882>`__)
439-
- MultiError now defines its ``exceptions`` attribute in ``__init__()``
439+
- ``MultiError`` now defines its ``exceptions`` attribute in ``__init__()``
440440
to better support linters and code autocompletion. (`#1066 <https://github.com/python-trio/trio/issues/1066>`__)
441441
- Use ``__slots__`` in more places internally, which should make Trio slightly faster. (`#984 <https://github.com/python-trio/trio/issues/984>`__)
442442

@@ -457,7 +457,7 @@ Bugfixes
457457
:meth:`~trio.Path.cwd`, are now async functions. Previously, a bug
458458
in the forwarding logic meant :meth:`~trio.Path.cwd` was synchronous
459459
and :meth:`~trio.Path.home` didn't work at all. (`#960 <https://github.com/python-trio/trio/issues/960>`__)
460-
- An exception encapsulated within a :class:`MultiError` doesn't need to be
460+
- An exception encapsulated within a `MultiError` doesn't need to be
461461
hashable anymore.
462462

463463
.. note::
@@ -1248,7 +1248,7 @@ Other changes
12481248
interfering with direct use of
12491249
:func:`~trio.testing.wait_all_tasks_blocked` in the same test.
12501250

1251-
* :meth:`MultiError.catch` now correctly preserves ``__context__``,
1251+
* ``MultiError.catch()`` now correctly preserves ``__context__``,
12521252
despite Python's best attempts to stop us (`#165
12531253
<https://github.com/python-trio/trio/issues/165>`__)
12541254

docs/source/reference-core.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -641,7 +641,7 @@ crucial things to keep in mind:
641641

642642
* Any unhandled exceptions are re-raised inside the parent task. If
643643
there are multiple exceptions, then they're collected up into a
644-
single :exc:`BaseExceptionGroup` or :exc:`ExceptionGroup` exception.
644+
single ``BaseExceptionGroup`` or ``ExceptionGroup`` exception.
645645

646646
Since all tasks are descendents of the initial task, one consequence
647647
of this is that :func:`run` can't finish until all tasks have
@@ -712,9 +712,9 @@ limitation. Consider code like::
712712
what? In some sense, the answer should be "both of these at once", but
713713
in Python there can only be one exception at a time.
714714

715-
Trio's answer is that it raises a :exc:`BaseExceptionGroup` object. This is a
715+
Trio's answer is that it raises a ``BaseExceptionGroup`` object. This is a
716716
special exception which encapsulates multiple exception objects –
717-
either regular exceptions or nested :exc:`BaseExceptionGroup`\s.
717+
either regular exceptions or nested ``BaseExceptionGroup``\s.
718718

719719

720720
Spawning tasks without becoming a parent

0 commit comments

Comments
 (0)