diff options
author | Serhiy Storchaka <storchaka@gmail.com> | 2022-05-21 07:33:23 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-05-21 07:33:23 (GMT) |
commit | 7f835923c179d1d2da54b232e0113abc2c56ea31 (patch) | |
tree | 6aa850b6020bcf040158cf84b560bbbe5ec50288 | |
parent | 2fadde7e6645e45e090b0187c28877300b07cba3 (diff) | |
download | cpython-7f835923c179d1d2da54b232e0113abc2c56ea31.zip cpython-7f835923c179d1d2da54b232e0113abc2c56ea31.tar.gz cpython-7f835923c179d1d2da54b232e0113abc2c56ea31.tar.bz2 |
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).
-rw-r--r-- | Doc/library/email.headerregistry.rst | 2 | ||||
-rw-r--r-- | Doc/library/functions.rst | 1 | ||||
-rw-r--r-- | Doc/library/logging.config.rst | 6 | ||||
-rw-r--r-- | Doc/library/stdtypes.rst | 2 | ||||
-rw-r--r-- | Doc/library/threading.rst | 6 | ||||
-rw-r--r-- | Doc/library/weakref.rst | 2 | ||||
-rw-r--r-- | Doc/whatsnew/3.4.rst | 6 |
7 files changed, 16 insertions, 9 deletions
diff --git a/Doc/library/email.headerregistry.rst b/Doc/library/email.headerregistry.rst index 3e1d97a..98527ce 100644 --- a/Doc/library/email.headerregistry.rst +++ b/Doc/library/email.headerregistry.rst @@ -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 ``', '``. diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 92b2c3b..f5e4c1a 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -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]]) diff --git a/Doc/library/logging.config.rst b/Doc/library/logging.config.rst index 2f105ba..310796e 100644 --- a/Doc/library/logging.config.rst +++ b/Doc/library/logging.config.rst @@ -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 ``{}``. diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index 065afb8..33fd283 100644 --- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -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*. diff --git a/Doc/library/threading.rst b/Doc/library/threading.rst index 0bc1f9d..58e4ad7 100644 --- a/Doc/library/threading.rst +++ b/Doc/library/threading.rst @@ -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 diff --git a/Doc/library/weakref.rst b/Doc/library/weakref.rst index 1102c63..8397de4 100644 --- a/Doc/library/weakref.rst +++ b/Doc/library/weakref.rst @@ -1,3 +1,5 @@ +.. _mod-weakref: + :mod:`weakref` --- Weak references ================================== diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst index f4ff143..0237361 100644 --- a/Doc/whatsnew/3.4.rst +++ b/Doc/whatsnew/3.4.rst @@ -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 |