gh-71223: Improve rendering of some references in the docs (GH-93041)

For example, instead of "eval()uated" (link from "eval()")
show "evaluated" (link from the whole word).
This commit is contained in:
Serhiy Storchaka 2022-05-21 10:33:23 +03:00 committed by GitHub
parent 2fadde7e66
commit 7f835923c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 16 additions and 9 deletions

View File

@ -206,7 +206,7 @@ headers.
The ``decoded`` value of the header will have all encoded words decoded to
unicode. :class:`~encodings.idna` encoded domain names are also decoded to
unicode. The ``decoded`` value is set by :attr:`~str.join`\ ing the
unicode. The ``decoded`` value is set by :ref:`joining <meth-str-join>` the
:class:`str` value of the elements of the ``groups`` attribute with ``',
'``.

View File

@ -500,6 +500,7 @@ are always available. They are listed here in alphabetical order.
yield n, elem
n += 1
.. _func-eval:
.. function:: eval(expression[, globals[, locals]])

View File

@ -716,7 +716,7 @@ root logger section is given below.
The ``level`` entry can be one of ``DEBUG, INFO, WARNING, ERROR, CRITICAL`` or
``NOTSET``. For the root logger only, ``NOTSET`` means that all messages will be
logged. Level values are :func:`eval`\ uated in the context of the ``logging``
logged. Level values are :ref:`evaluated <func-eval>` in the context of the ``logging``
package's namespace.
The ``handlers`` entry is a comma-separated list of handler names, which must
@ -763,13 +763,13 @@ handler. If blank, a default formatter (``logging._defaultFormatter``) is used.
If a name is specified, it must appear in the ``[formatters]`` section and have
a corresponding section in the configuration file.
The ``args`` entry, when :func:`eval`\ uated in the context of the ``logging``
The ``args`` entry, when :ref:`evaluated <func-eval>` in the context of the ``logging``
package's namespace, is the list of arguments to the constructor for the handler
class. Refer to the constructors for the relevant handlers, or to the examples
below, to see how typical entries are constructed. If not provided, it defaults
to ``()``.
The optional ``kwargs`` entry, when :func:`eval`\ uated in the context of the
The optional ``kwargs`` entry, when :ref:`evaluated <func-eval>` in the context of the
``logging`` package's namespace, is the keyword argument dict to the constructor
for the handler class. If not provided, it defaults to ``{}``.

View File

@ -1866,6 +1866,8 @@ expression support in the :mod:`re` module).
.. _meth-str-join:
.. method:: str.join(iterable)
Return a string which is the concatenation of the strings in *iterable*.

View File

@ -293,7 +293,7 @@ There is the possibility that "dummy thread objects" are created. These are
thread objects corresponding to "alien threads", which are threads of control
started outside the threading module, such as directly from C code. Dummy
thread objects have limited functionality; they are always considered alive and
daemonic, and cannot be :meth:`~Thread.join`\ ed. They are never deleted,
daemonic, and cannot be :ref:`joined <meth-thread-join>`. They are never deleted,
since it is impossible to detect the termination of alien threads.
@ -366,6 +366,8 @@ since it is impossible to detect the termination of alien threads.
>>> t.run()
1
.. _meth-thread-join:
.. method:: join(timeout=None)
Wait until the thread terminates. This blocks the calling thread until
@ -383,7 +385,7 @@ since it is impossible to detect the termination of alien threads.
When the *timeout* argument is not present or ``None``, the operation will
block until the thread terminates.
A thread can be :meth:`~Thread.join`\ ed many times.
A thread can be joined many times.
:meth:`~Thread.join` raises a :exc:`RuntimeError` if an attempt is made
to join the current thread as that would cause a deadlock. It is also

View File

@ -1,3 +1,5 @@
.. _mod-weakref:
:mod:`weakref` --- Weak references
==================================

View File

@ -409,7 +409,7 @@ Some smaller changes made to the core Python language are:
evaluating has no elements. (Contributed by Julian Berman in
:issue:`18111`.)
* Module objects are now :mod:`weakref`'able.
* Module objects are now :ref:`weakly referenceable <mod-weakref>`.
* Module ``__file__`` attributes (and related values) should now always
contain absolute paths by default, with the sole exception of
@ -1113,8 +1113,8 @@ with additional speedups by Antoine Pitrou in :issue:`19219`.)
mmap
----
mmap objects can now be :mod:`weakref`\ ed. (Contributed by Valerie Lambert in
:issue:`4885`.)
mmap objects are now :ref:`weakly referenceable <mod-weakref>`.
(Contributed by Valerie Lambert in :issue:`4885`.)
multiprocessing