summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorRafael Fontenelle <rffontenelle@users.noreply.github.com>2024-09-17 13:02:14 (GMT)
committerGitHub <noreply@github.com>2024-09-17 13:02:14 (GMT)
commit33eeccf6d4f16e483b4c8a180bad718545aeaeaf (patch)
tree7f528774c81a291c48a4ab5746a589eea75911f4 /Doc
parent4d0971934145698bc57d287bb9fe9112bd325899 (diff)
downloadcpython-33eeccf6d4f16e483b4c8a180bad718545aeaeaf.zip
cpython-33eeccf6d4f16e483b4c8a180bad718545aeaeaf.tar.gz
cpython-33eeccf6d4f16e483b4c8a180bad718545aeaeaf.tar.bz2
Use pep role instead of url (#121611)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/code.rst4
-rw-r--r--Doc/c-api/refcounting.rst4
-rw-r--r--Doc/faq/general.rst4
-rw-r--r--Doc/library/ast.rst3
-rw-r--r--Doc/library/sqlite3.rst29
-rw-r--r--Doc/library/wsgiref.rst16
-rw-r--r--Doc/whatsnew/2.7.rst6
-rw-r--r--Doc/whatsnew/3.12.rst2
-rw-r--r--Doc/whatsnew/3.4.rst5
-rw-r--r--Doc/whatsnew/3.7.rst2
10 files changed, 35 insertions, 40 deletions
diff --git a/Doc/c-api/code.rst b/Doc/c-api/code.rst
index 968c472..6ae6bfe 100644
--- a/Doc/c-api/code.rst
+++ b/Doc/c-api/code.rst
@@ -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.
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)
diff --git a/Doc/c-api/refcounting.rst b/Doc/c-api/refcounting.rst
index bf50107..d75dad73 100644
--- a/Doc/c-api/refcounting.rst
+++ b/Doc/c-api/refcounting.rst
@@ -62,7 +62,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
@@ -130,7 +130,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::
diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst
index eb859c5..31df5eb 100644
--- a/Doc/faq/general.rst
+++ b/Doc/faq/general.rst
@@ -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?
---------------------------------
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
index 8c80a79..f299473 100644
--- a/Doc/library/ast.rst
+++ b/Doc/library/ast.rst
@@ -2033,8 +2033,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`.
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 0e51269..fc03838 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -525,21 +525,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
diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst
index e46730f..8d4c5eb 100644
--- a/Doc/library/wsgiref.rst
+++ b/Doc/library/wsgiref.rst
@@ -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
@@ -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.
diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst
index ca5dfd2..0e4dee0 100644
--- a/Doc/whatsnew/2.7.rst
+++ b/Doc/whatsnew/2.7.rst
@@ -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
~~~~~~~~~~~~~~~~~~~~~
diff --git a/Doc/whatsnew/3.12.rst b/Doc/whatsnew/3.12.rst
index 99bb393..5e79d48 100644
--- a/Doc/whatsnew/3.12.rst
+++ b/Doc/whatsnew/3.12.rst
@@ -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`,
diff --git a/Doc/whatsnew/3.4.rst b/Doc/whatsnew/3.4.rst
index fbfcb87..b5f2177 100644
--- a/Doc/whatsnew/3.4.rst
+++ b/Doc/whatsnew/3.4.rst
@@ -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,
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
index 3dd8ed2..2d433ef 100644
--- a/Doc/whatsnew/3.7.rst
+++ b/Doc/whatsnew/3.7.rst
@@ -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`.