Skip to content

Commit

Permalink
[3.12] Use pep role instead of url (pythonGH-121611) (python#124173)
Browse files Browse the repository at this point in the history
Co-authored-by: Rafael Fontenelle <[email protected]>
  • Loading branch information
miss-islington and rffontenelle authored Sep 17, 2024
1 parent c54ee87 commit a032a96
Show file tree
Hide file tree
Showing 11 changed files with 37 additions and 42 deletions.
4 changes: 2 additions & 2 deletions Doc/c-api/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,8 @@ bound into a function.
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.
For efficiently iterating over the line numbers in a code object, use `the API described in PEP 626
<https://peps.python.org/pep-0626/#out-of-process-debuggers-and-profilers>`_.
For efficiently iterating over the line numbers in a code object, use :pep:`the API described in PEP 626
<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)
Expand Down
4 changes: 2 additions & 2 deletions Doc/c-api/refcounting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ of Python objects.
``NULL``, use :c:func:`Py_XINCREF`.
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.
.. versionchanged:: 3.12
Expand Down Expand Up @@ -125,7 +125,7 @@ of Python objects.
use :c:func:`Py_XDECREF`.
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.
.. warning::
Expand Down
4 changes: 2 additions & 2 deletions Doc/faq/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -311,8 +311,8 @@ releases.
The latest stable releases can always be found on the `Python download page
<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
most widely used libraries. Although 2.x is still widely used, `it is not
maintained anymore <https://peps.python.org/pep-0373/>`_.
most widely used libraries. Although 2.x is still widely used, :pep:`it is not
maintained anymore <0373>`.

How many people are using Python?
---------------------------------
Expand Down
3 changes: 1 addition & 2 deletions Doc/library/ast.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2060,8 +2060,7 @@ Function and class definitions
* ``name`` is a raw string for the class name
* ``bases`` is a list of nodes for explicitly specified base classes.
* ``keywords`` is a list of :class:`.keyword` nodes, principally for 'metaclass'.
Other keywords will be passed to the metaclass, as per `PEP-3115
<https://peps.python.org/pep-3115/>`_.
Other keywords will be passed to the metaclass, as per :pep:`3115`.
* ``body`` is a list of nodes representing the code within the class
definition.
* ``decorator_list`` is a list of nodes, as in :class:`FunctionDef`.
Expand Down
29 changes: 14 additions & 15 deletions Doc/library/sqlite3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -519,21 +519,20 @@ Module constants
The mappings from SQLite threading modes to DB-API 2.0 threadsafety levels
are as follows:

+------------------+-----------------+----------------------+-------------------------------+
| SQLite threading | `threadsafety`_ | `SQLITE_THREADSAFE`_ | DB-API 2.0 meaning |
| mode | | | |
+==================+=================+======================+===============================+
| single-thread | 0 | 0 | Threads may not share the |
| | | | module |
+------------------+-----------------+----------------------+-------------------------------+
| multi-thread | 1 | 2 | Threads may share the module, |
| | | | but not connections |
+------------------+-----------------+----------------------+-------------------------------+
| serialized | 3 | 1 | Threads may share the module, |
| | | | connections and cursors |
+------------------+-----------------+----------------------+-------------------------------+

.. _threadsafety: https://peps.python.org/pep-0249/#threadsafety
+------------------+----------------------+----------------------+-------------------------------+
| SQLite threading | :pep:`threadsafety | `SQLITE_THREADSAFE`_ | DB-API 2.0 meaning |
| mode | <0249#threadsafety>` | | |
+==================+======================+======================+===============================+
| single-thread | 0 | 0 | Threads may not share the |
| | | | module |
+------------------+----------------------+----------------------+-------------------------------+
| multi-thread | 1 | 2 | Threads may share the module, |
| | | | but not connections |
+------------------+----------------------+----------------------+-------------------------------+
| serialized | 3 | 1 | Threads may share the module, |
| | | | connections and cursors |
+------------------+----------------------+----------------------+-------------------------------+

.. _SQLITE_THREADSAFE: https://sqlite.org/compile.html#threadsafe

.. versionchanged:: 3.11
Expand Down
16 changes: 8 additions & 8 deletions Doc/library/wsgiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -783,8 +783,8 @@ in :pep:`3333`.

.. class:: StartResponse()

A :class:`typing.Protocol` describing `start_response()
<https://peps.python.org/pep-3333/#the-start-response-callable>`_
A :class:`typing.Protocol` describing :pep:`start_response()
<3333#the-start-response-callable>`
callables (:pep:`3333`).

.. data:: WSGIEnvironment
Expand All @@ -797,18 +797,18 @@ in :pep:`3333`.

.. class:: InputStream()

A :class:`typing.Protocol` describing a `WSGI Input Stream
<https://peps.python.org/pep-3333/#input-and-error-streams>`_.
A :class:`typing.Protocol` describing a :pep:`WSGI Input Stream
<3333#input-and-error-streams>`.

.. class:: ErrorStream()

A :class:`typing.Protocol` describing a `WSGI Error Stream
<https://peps.python.org/pep-3333/#input-and-error-streams>`_.
A :class:`typing.Protocol` describing a :pep:`WSGI Error Stream
<3333#input-and-error-streams>`.

.. class:: FileWrapper()

A :class:`typing.Protocol` describing a `file wrapper
<https://peps.python.org/pep-3333/#optional-platform-specific-file-handling>`_.
A :class:`typing.Protocol` describing a :pep:`file wrapper
<3333#optional-platform-specific-file-handling>`.
See :class:`wsgiref.util.FileWrapper` for a concrete implementation of this
protocol.

Expand Down
6 changes: 2 additions & 4 deletions Doc/whatsnew/2.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
simple directions on how to install them on that platform (usually using
the system package manager).

__ https://peps.python.org/pep-0477/#disabling-ensurepip-by-downstream-distributors


Documentation Changes
~~~~~~~~~~~~~~~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.12.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Important deprecations, removals or restrictions:
reducing the size of every :class:`str` object by at least 8 bytes.

* :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.
The third-party `Setuptools <https://setuptools.pypa.io/en/latest/deprecated/distutils-legacy.html>`__
package continues to provide :mod:`!distutils`,
Expand Down
5 changes: 2 additions & 3 deletions Doc/whatsnew/3.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
simple directions on how to install them on that platform (usually using
the system package manager).

__ https://peps.python.org/pep-0453/#recommendations-for-downstream-distributors

.. note::

To avoid conflicts between parallel Python 2 and Python 3 installations,
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ module:

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
approximately 3 times better than that of :func:`time.time`.

Expand Down
4 changes: 2 additions & 2 deletions Misc/NEWS.d/3.11.0b1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1801,8 +1801,8 @@ The documentation now lists which members of C structs are part of the
.. section: Documentation

All docstrings in code snippets are now wrapped into :c:macro:`PyDoc_STR` to
follow the guideline of `PEP 7's Documentation Strings paragraph
<https://www.python.org/dev/peps/pep-0007/#documentation-strings>`_. Patch
follow the guideline of :pep:`PEP 7's Documentation Strings paragraph
<0007#documentation-strings>`. Patch
by Oleg Iarygin.

..
Expand Down

0 comments on commit a032a96

Please sign in to comment.