Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor to default role obj #1091

Merged
merged 1 commit into from
Jun 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
("py:exc", "Anything else"),
]
autodoc_inherit_docstrings = False
default_role = "obj"

# XX hack the RTD theme until
# https://github.com/rtfd/sphinx_rtd_theme/pull/382
Expand Down
4 changes: 2 additions & 2 deletions docs/source/history.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Features
also reexports all the stdlib :mod:`subprocess` exceptions and constants for
convenience. (`#4 <https://github.com/python-trio/trio/issues/4>`__)
- You can now create an unbounded :class:`CapacityLimiter` by initializing with
:obj:`math.inf` (`#618 <https://github.com/python-trio/trio/issues/618>`__)
`math.inf` (`#618 <https://github.com/python-trio/trio/issues/618>`__)
- New :mod:`trio.hazmat` features to allow cleanly switching live coroutine
objects between Trio and other coroutine runners. Frankly, we're not even
sure this is a good idea, but we want to `try it out in trio-asyncio
Expand Down Expand Up @@ -238,7 +238,7 @@ Bugfixes
- Prevent crashes when used with Sentry (raven-python). (`#599
<https://github.com/python-trio/trio/issues/599>`__)
- The nursery context manager was rewritten to avoid use of
`@asynccontextmanager` and `@async_generator`. This reduces extraneous frames
``@asynccontextmanager`` and ``@async_generator``. This reduces extraneous frames
in exception traces and addresses bugs regarding `StopIteration` and
`StopAsyncIteration` exceptions not propagating correctly. (`#612
<https://github.com/python-trio/trio/issues/612>`__)
Expand Down
2 changes: 1 addition & 1 deletion docs/source/reference-core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ in Python there can only be one exception at a time.
Trio's answer is that it raises a :exc:`MultiError` object. This is a
special exception which encapsulates multiple exception objects –
either regular exceptions or nested :exc:`MultiError`\s. To make these
easier to work with, Trio installs a custom :obj:`sys.excepthook` that
easier to work with, Trio installs a custom `sys.excepthook` that
knows how to print nice tracebacks for unhandled :exc:`MultiError`\s,
and it also provides some helpful utilities like
:meth:`MultiError.catch`, which allows you to catch "part of" a
Expand Down
2 changes: 1 addition & 1 deletion trio/_file_io.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def wrap_file(file):
file: a :term:`file object`

Returns:
An :term:`asynchronous file object` that wraps `file`
An :term:`asynchronous file object` that wraps ``file``

Example::

Expand Down
2 changes: 1 addition & 1 deletion trio/_highlevel_open_tcp_stream.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ async def open_tcp_stream(
port (int): The port to connect to.
happy_eyeballs_delay (float): How many seconds to wait for each
connection attempt to succeed or fail before getting impatient and
starting another one in parallel. Set to :obj:`math.inf` if you want
starting another one in parallel. Set to `math.inf` if you want
to limit to only one connection attempt at a time (like
:func:`socket.create_connection`). Default: 0.3 (300 ms).

Expand Down
2 changes: 1 addition & 1 deletion trio/_ssl.py
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ class SSLStream(Stream):
raises :exc:`NeedHandshakeError`.

This also means that if you register a SNI callback using
:obj:`~ssl.SSLContext.sni_callback`, then the first argument your callback
`~ssl.SSLContext.sni_callback`, then the first argument your callback
receives will be a :class:`ssl.SSLObject`.

"""
Expand Down