Use pep role instead of url (#121611)

This commit is contained in:
Rafael Fontenelle 2024-09-17 10:02:14 -03:00 committed by GitHub
parent 4d09719341
commit 33eeccf6d4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 36 additions and 41 deletions

View File

@ -96,8 +96,8 @@ bound into a function.
Return the line number of the instruction that occurs on or before ``byte_offset`` and ends after it. Return the line number of the instruction that occurs on or before ``byte_offset`` and ends after it.
If you just need the line number of a frame, use :c:func:`PyFrame_GetLineNumber` instead. If you just need the line number of a frame, use :c:func:`PyFrame_GetLineNumber` instead.
For efficiently iterating over the line numbers in a code object, use `the API described in PEP 626 For efficiently iterating over the line numbers in a code object, use :pep:`the API described in PEP 626
<https://peps.python.org/pep-0626/#out-of-process-debuggers-and-profilers>`_. <0626#out-of-process-debuggers-and-profilers>`.
.. c:function:: int PyCode_Addr2Location(PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column) .. c:function:: int PyCode_Addr2Location(PyObject *co, int byte_offset, int *start_line, int *start_column, int *end_line, int *end_column)

View File

@ -62,7 +62,7 @@ of Python objects.
``NULL``, use :c:func:`Py_XINCREF`. ``NULL``, use :c:func:`Py_XINCREF`.
Do not expect this function to actually modify *o* in any way. Do not expect this function to actually modify *o* in any way.
For at least `some objects <https://peps.python.org/pep-0683/>`_, For at least :pep:`some objects <0683>`,
this function has no effect. this function has no effect.
.. versionchanged:: 3.12 .. versionchanged:: 3.12
@ -130,7 +130,7 @@ of Python objects.
use :c:func:`Py_XDECREF`. use :c:func:`Py_XDECREF`.
Do not expect this function to actually modify *o* in any way. Do not expect this function to actually modify *o* in any way.
For at least `some objects <https://peps.python.org/pep-0683/>`_, For at least :pep:`some objects <683>`,
this function has no effect. this function has no effect.
.. warning:: .. warning::

View File

@ -311,8 +311,8 @@ releases.
The latest stable releases can always be found on the `Python download page The latest stable releases can always be found on the `Python download page
<https://www.python.org/downloads/>`_. There are two production-ready versions <https://www.python.org/downloads/>`_. There are two production-ready versions
of Python: 2.x and 3.x. The recommended version is 3.x, which is supported by of Python: 2.x and 3.x. The recommended version is 3.x, which is supported by
most widely used libraries. Although 2.x is still widely used, `it is not most widely used libraries. Although 2.x is still widely used, :pep:`it is not
maintained anymore <https://peps.python.org/pep-0373/>`_. maintained anymore <0373>`.
How many people are using Python? How many people are using Python?
--------------------------------- ---------------------------------

View File

@ -2033,8 +2033,7 @@ Function and class definitions
* ``name`` is a raw string for the class name * ``name`` is a raw string for the class name
* ``bases`` is a list of nodes for explicitly specified base classes. * ``bases`` is a list of nodes for explicitly specified base classes.
* ``keywords`` is a list of :class:`.keyword` nodes, principally for 'metaclass'. * ``keywords`` is a list of :class:`.keyword` nodes, principally for 'metaclass'.
Other keywords will be passed to the metaclass, as per `PEP-3115 Other keywords will be passed to the metaclass, as per :pep:`3115`.
<https://peps.python.org/pep-3115/>`_.
* ``body`` is a list of nodes representing the code within the class * ``body`` is a list of nodes representing the code within the class
definition. definition.
* ``decorator_list`` is a list of nodes, as in :class:`FunctionDef`. * ``decorator_list`` is a list of nodes, as in :class:`FunctionDef`.

View File

@ -525,21 +525,20 @@ Module constants
The mappings from SQLite threading modes to DB-API 2.0 threadsafety levels The mappings from SQLite threading modes to DB-API 2.0 threadsafety levels
are as follows: are as follows:
+------------------+-----------------+----------------------+-------------------------------+ +------------------+----------------------+----------------------+-------------------------------+
| SQLite threading | `threadsafety`_ | `SQLITE_THREADSAFE`_ | DB-API 2.0 meaning | | SQLite threading | :pep:`threadsafety | `SQLITE_THREADSAFE`_ | DB-API 2.0 meaning |
| mode | | | | | mode | <0249#threadsafety>` | | |
+==================+=================+======================+===============================+ +==================+======================+======================+===============================+
| single-thread | 0 | 0 | Threads may not share the | | single-thread | 0 | 0 | Threads may not share the |
| | | | module | | | | | module |
+------------------+-----------------+----------------------+-------------------------------+ +------------------+----------------------+----------------------+-------------------------------+
| multi-thread | 1 | 2 | Threads may share the module, | | multi-thread | 1 | 2 | Threads may share the module, |
| | | | but not connections | | | | | but not connections |
+------------------+-----------------+----------------------+-------------------------------+ +------------------+----------------------+----------------------+-------------------------------+
| serialized | 3 | 1 | Threads may share the module, | | serialized | 3 | 1 | Threads may share the module, |
| | | | connections and cursors | | | | | connections and cursors |
+------------------+-----------------+----------------------+-------------------------------+ +------------------+----------------------+----------------------+-------------------------------+
.. _threadsafety: https://peps.python.org/pep-0249/#threadsafety
.. _SQLITE_THREADSAFE: https://sqlite.org/compile.html#threadsafe .. _SQLITE_THREADSAFE: https://sqlite.org/compile.html#threadsafe
.. versionchanged:: 3.11 .. versionchanged:: 3.11

View File

@ -783,8 +783,8 @@ in :pep:`3333`.
.. class:: StartResponse() .. class:: StartResponse()
A :class:`typing.Protocol` describing `start_response() A :class:`typing.Protocol` describing :pep:`start_response()
<https://peps.python.org/pep-3333/#the-start-response-callable>`_ <3333#the-start-response-callable>`
callables (:pep:`3333`). callables (:pep:`3333`).
.. data:: WSGIEnvironment .. data:: WSGIEnvironment
@ -797,18 +797,18 @@ in :pep:`3333`.
.. class:: InputStream() .. class:: InputStream()
A :class:`typing.Protocol` describing a `WSGI Input Stream A :class:`typing.Protocol` describing a :pep:`WSGI Input Stream
<https://peps.python.org/pep-3333/#input-and-error-streams>`_. <3333#input-and-error-streams>`.
.. class:: ErrorStream() .. class:: ErrorStream()
A :class:`typing.Protocol` describing a `WSGI Error Stream A :class:`typing.Protocol` describing a :pep:`WSGI Error Stream
<https://peps.python.org/pep-3333/#input-and-error-streams>`_. <3333#input-and-error-streams>`.
.. class:: FileWrapper() .. class:: FileWrapper()
A :class:`typing.Protocol` describing a `file wrapper A :class:`typing.Protocol` describing a :pep:`file wrapper
<https://peps.python.org/pep-3333/#optional-platform-specific-file-handling>`_. <3333#optional-platform-specific-file-handling>`.
See :class:`wsgiref.util.FileWrapper` for a concrete implementation of this See :class:`wsgiref.util.FileWrapper` for a concrete implementation of this
protocol. protocol.

View File

@ -2680,14 +2680,12 @@ automatic ``PATH`` modifications to have ``pip`` available from the command
line by default, otherwise it can still be accessed through the Python line by default, otherwise it can still be accessed through the Python
launcher for Windows as ``py -m pip``. launcher for Windows as ``py -m pip``.
As `discussed in the PEP`__, platform packagers may choose not to install As :pep:`discussed in the PEP <0477#disabling-ensurepip-by-downstream-distributors>`,
platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear and these commands by default, as long as, when invoked, they provide clear and
simple directions on how to install them on that platform (usually using simple directions on how to install them on that platform (usually using
the system package manager). the system package manager).
__ https://peps.python.org/pep-0477/#disabling-ensurepip-by-downstream-distributors
Documentation Changes Documentation Changes
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~

View File

@ -154,7 +154,7 @@ Important deprecations, removals or restrictions:
reducing the size of every :class:`str` object by at least 8 bytes. reducing the size of every :class:`str` object by at least 8 bytes.
* :pep:`632`: Remove the :mod:`!distutils` package. * :pep:`632`: Remove the :mod:`!distutils` package.
See `the migration guide <https://peps.python.org/pep-0632/#migration-advice>`_ See :pep:`the migration guide <0632#migration-advice>`
for advice replacing the APIs it provided. for advice replacing the APIs it provided.
The third-party `Setuptools <https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html>`__ The third-party `Setuptools <https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html>`__
package continues to provide :mod:`!distutils`, package continues to provide :mod:`!distutils`,

View File

@ -215,13 +215,12 @@ automatic ``PATH`` modifications to have ``pip`` available from the command
line by default, otherwise it can still be accessed through the Python line by default, otherwise it can still be accessed through the Python
launcher for Windows as ``py -m pip``. launcher for Windows as ``py -m pip``.
As `discussed in the PEP`__, platform packagers may choose not to install As :pep:`discussed in the PEP <0453#recommendations-for-downstream-distributors>`
platform packagers may choose not to install
these commands by default, as long as, when invoked, they provide clear and these commands by default, as long as, when invoked, they provide clear and
simple directions on how to install them on that platform (usually using simple directions on how to install them on that platform (usually using
the system package manager). the system package manager).
__ https://peps.python.org/pep-0453/#recommendations-for-downstream-distributors
.. note:: .. note::
To avoid conflicts between parallel Python 2 and Python 3 installations, To avoid conflicts between parallel Python 2 and Python 3 installations,

View File

@ -353,7 +353,7 @@ module:
The new functions return the number of nanoseconds as an integer value. The new functions return the number of nanoseconds as an integer value.
`Measurements <https://peps.python.org/pep-0564/#annex-clocks-resolution-in-python>`_ :pep:`Measurements <0564#annex-clocks-resolution-in-python>`
show that on Linux and Windows the resolution of :func:`time.time_ns` is show that on Linux and Windows the resolution of :func:`time.time_ns` is
approximately 3 times better than that of :func:`time.time`. approximately 3 times better than that of :func:`time.time`.

View File

@ -1801,8 +1801,8 @@ The documentation now lists which members of C structs are part of the
.. section: Documentation .. section: Documentation
All docstrings in code snippets are now wrapped into :c:macro:`PyDoc_STR` to All docstrings in code snippets are now wrapped into :c:macro:`PyDoc_STR` to
follow the guideline of `PEP 7's Documentation Strings paragraph follow the guideline of :pep:`PEP 7's Documentation Strings paragraph
<https://www.python.org/dev/peps/pep-0007/#documentation-strings>`_. Patch <0007#documentation-strings>`. Patch
by Oleg Iarygin. by Oleg Iarygin.
.. ..