Skip to content

gh-111151: Convert monospaced directives to :ref: #111152

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

Merged
merged 3 commits into from
Oct 24, 2023
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
6 changes: 6 additions & 0 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -661,6 +661,8 @@ Opening network connections
Creating network servers
^^^^^^^^^^^^^^^^^^^^^^^^

.. _loop_create_server:

.. coroutinemethod:: loop.create_server(protocol_factory, \
host=None, port=None, *, \
family=socket.AF_UNSPEC, \
Expand Down Expand Up @@ -1191,6 +1193,8 @@ Working with pipes
Unix signals
^^^^^^^^^^^^

.. _loop_add_signal_handler:

.. method:: loop.add_signal_handler(signum, callback, *args)

Set *callback* as the handler for the *signum* signal.
Expand Down Expand Up @@ -1411,6 +1415,8 @@ async/await code consider using the high-level
:ref:`Subprocess Support on Windows <asyncio-windows-subprocess>` for
details.

.. _loop_subprocess_exec:

.. coroutinemethod:: loop.subprocess_exec(protocol_factory, *args, \
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
stderr=subprocess.PIPE, **kwargs)
Expand Down
6 changes: 3 additions & 3 deletions Doc/library/asyncio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ Additionally, there are **low-level** APIs for
*library and framework developers* to:

* create and manage :ref:`event loops <asyncio-event-loop>`, which
provide asynchronous APIs for :meth:`networking <loop.create_server>`,
running :meth:`subprocesses <loop.subprocess_exec>`,
handling :meth:`OS signals <loop.add_signal_handler>`, etc;
provide asynchronous APIs for :ref:`networking <loop_create_server>`,
running :ref:`subprocesses <loop_subprocess_exec>`,
handling :ref:`OS signals <loop_add_signal_handler>`, etc;

* implement efficient protocols using
:ref:`transports <asyncio-transports-protocols>`;
Expand Down
16 changes: 11 additions & 5 deletions Doc/library/typing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -304,7 +304,7 @@ a callable with any arbitrary parameter list would be acceptable:
x = concat # Also OK

``Callable`` cannot express complex signatures such as functions that take a
variadic number of arguments, :func:`overloaded functions <overload>`, or
variadic number of arguments, :ref:`overloaded functions <overload>`, or
functions that have keyword-only parameters. However, these signatures can be
expressed by defining a :class:`Protocol` class with a
:meth:`~object.__call__` method:
Expand Down Expand Up @@ -526,7 +526,7 @@ A user-defined class can be defined as a generic class.
self.logger.info('%s: %s', self.name, message)

This syntax indicates that the class ``LoggedVar`` is parameterised around a
single :class:`type variable <TypeVar>` ``T`` . This also makes ``T`` valid as
single :ref:`type variable <typevar>` ``T`` . This also makes ``T`` valid as
a type within the class body.

Generic classes implicitly inherit from :class:`Generic`. For compatibility
Expand Down Expand Up @@ -1493,7 +1493,7 @@ These can be used as types in annotations. They all support subscription using
Typing operator to conceptually mark an object as having been unpacked.

For example, using the unpack operator ``*`` on a
:class:`type variable tuple <TypeVarTuple>` is equivalent to using ``Unpack``
:ref:`type variable tuple <typevartuple>` is equivalent to using ``Unpack``
to mark the type variable tuple as having been unpacked::

Ts = TypeVarTuple('Ts')
Expand Down Expand Up @@ -1584,6 +1584,8 @@ without the dedicated syntax, as documented below.
...
# Etc.

.. _typevar:

.. class:: TypeVar(name, *constraints, bound=None, covariant=False, contravariant=False, infer_variance=False)

Type variable.
Expand Down Expand Up @@ -1728,9 +1730,11 @@ without the dedicated syntax, as documented below.
:ref:`type parameter <type-params>` syntax introduced by :pep:`695`.
The ``infer_variance`` parameter was added.

.. _typevartuple:

.. class:: TypeVarTuple(name)

Type variable tuple. A specialized form of :class:`type variable <TypeVar>`
Type variable tuple. A specialized form of :ref:`type variable <typevar>`
that enables *variadic* generics.

Type variable tuples can be declared in :ref:`type parameter lists <type-params>`
Expand Down Expand Up @@ -1848,7 +1852,7 @@ without the dedicated syntax, as documented below.
.. class:: ParamSpec(name, *, bound=None, covariant=False, contravariant=False)

Parameter specification variable. A specialized version of
:class:`type variables <TypeVar>`.
:ref:`type variables <typevar>`.

In :ref:`type parameter lists <type-params>`, parameter specifications
can be declared with two asterisks (``**``)::
Expand Down Expand Up @@ -2772,6 +2776,8 @@ Functions and decorators

.. versionadded:: 3.11

.. _overload:

.. decorator:: overload

Decorator for creating overloaded functions and methods.
Expand Down