summaryrefslogtreecommitdiffstats
path: root/Misc
diff options
context:
space:
mode:
authorSerhiy Storchaka <storchaka@gmail.com>2023-08-22 12:50:30 (GMT)
committerGitHub <noreply@github.com>2023-08-22 12:50:30 (GMT)
commitd7202e4879bf4e7e00a69500ddcb3143864139b4 (patch)
tree9f1c6a1ab8efff6c1ab9ee4c003d04e2950e3508 /Misc
parentc556f9a3c9af48c9af9e1f298be638553a6c886e (diff)
downloadcpython-d7202e4879bf4e7e00a69500ddcb3143864139b4.zip
cpython-d7202e4879bf4e7e00a69500ddcb3143864139b4.tar.gz
cpython-d7202e4879bf4e7e00a69500ddcb3143864139b4.tar.bz2
gh-107298: Fix numerous ref errors and typos in the C API docs (GH-108258)
Diffstat (limited to 'Misc')
-rw-r--r--Misc/NEWS.d/3.11.0a1.rst18
-rw-r--r--Misc/NEWS.d/3.8.0a1.rst4
-rw-r--r--Misc/NEWS.d/3.8.0a4.rst2
-rw-r--r--Misc/NEWS.d/3.8.0b1.rst2
-rw-r--r--Misc/NEWS.d/3.9.0a1.rst6
-rw-r--r--Misc/NEWS.d/3.9.0a5.rst4
6 files changed, 18 insertions, 18 deletions
diff --git a/Misc/NEWS.d/3.11.0a1.rst b/Misc/NEWS.d/3.11.0a1.rst
index 17ee513..e1d0adc 100644
--- a/Misc/NEWS.d/3.11.0a1.rst
+++ b/Misc/NEWS.d/3.11.0a1.rst
@@ -5036,15 +5036,15 @@ Limited API.
Deprecate the following functions to configure the Python initialization:
-* :c:func:`PySys_AddWarnOptionUnicode`
-* :c:func:`PySys_AddWarnOption`
-* :c:func:`PySys_AddXOption`
-* :c:func:`PySys_HasWarnOptions`
-* :c:func:`Py_SetPath`
-* :c:func:`Py_SetProgramName`
-* :c:func:`Py_SetPythonHome`
-* :c:func:`Py_SetStandardStreamEncoding`
-* :c:func:`_Py_SetProgramFullPath`
+* :c:func:`!PySys_AddWarnOptionUnicode`
+* :c:func:`!PySys_AddWarnOption`
+* :c:func:`!PySys_AddXOption`
+* :c:func:`!PySys_HasWarnOptions`
+* :c:func:`!Py_SetPath`
+* :c:func:`!Py_SetProgramName`
+* :c:func:`!Py_SetPythonHome`
+* :c:func:`!Py_SetStandardStreamEncoding`
+* :c:func:`!_Py_SetProgramFullPath`
Use the new :c:type:`PyConfig` API of the :ref:`Python Initialization
Configuration <init-config>` instead (:pep:`587`).
diff --git a/Misc/NEWS.d/3.8.0a1.rst b/Misc/NEWS.d/3.8.0a1.rst
index 467e992..dbbfb6e 100644
--- a/Misc/NEWS.d/3.8.0a1.rst
+++ b/Misc/NEWS.d/3.8.0a1.rst
@@ -8765,7 +8765,7 @@ for relative path to files in current directory.
.. nonce: fmehdG
.. section: C API
-The :c:func:`PyByteArray_Init` and :c:func:`PyByteArray_Fini` functions have
+The :c:func:`!PyByteArray_Init` and :c:func:`!PyByteArray_Fini` functions have
been removed. They did nothing since Python 2.7.4 and Python 3.2.0, were
excluded from the limited API (stable ABI), and were not documented.
@@ -8836,7 +8836,7 @@ Py_LIMITED_API. Patch by Arthur Neufeld.
.. nonce: gFd85N
.. section: C API
-The :c:func:`_PyObject_GC_TRACK` and :c:func:`_PyObject_GC_UNTRACK` macros
+The :c:func:`!_PyObject_GC_TRACK` and :c:func:`!_PyObject_GC_UNTRACK` macros
have been removed from the public C API.
..
diff --git a/Misc/NEWS.d/3.8.0a4.rst b/Misc/NEWS.d/3.8.0a4.rst
index 524a05a..2ce60f3 100644
--- a/Misc/NEWS.d/3.8.0a4.rst
+++ b/Misc/NEWS.d/3.8.0a4.rst
@@ -124,7 +124,7 @@ Galindo.
.. nonce: CjRps3
.. section: Core and Builtins
-:c:func:`PyEval_AcquireLock` and :c:func:`PyEval_AcquireThread` now
+:c:func:`!PyEval_AcquireLock` and :c:func:`!PyEval_AcquireThread` now
terminate the current thread if called while the interpreter is finalizing,
making them consistent with :c:func:`PyEval_RestoreThread`,
:c:func:`Py_END_ALLOW_THREADS`, and :c:func:`PyGILState_Ensure`.
diff --git a/Misc/NEWS.d/3.8.0b1.rst b/Misc/NEWS.d/3.8.0b1.rst
index 72e6b31..c5e27b0 100644
--- a/Misc/NEWS.d/3.8.0b1.rst
+++ b/Misc/NEWS.d/3.8.0b1.rst
@@ -2047,6 +2047,6 @@ unbound methods. These are objects supporting the optimization given by the
.. nonce: FR-dMP
.. section: C API
-The :c:func:`PyEval_ReInitThreads` function has been removed from the C API.
+The :c:func:`!PyEval_ReInitThreads` function has been removed from the C API.
It should not be called explicitly: use :c:func:`PyOS_AfterFork_Child`
instead.
diff --git a/Misc/NEWS.d/3.9.0a1.rst b/Misc/NEWS.d/3.9.0a1.rst
index 4367683..5a4431b 100644
--- a/Misc/NEWS.d/3.9.0a1.rst
+++ b/Misc/NEWS.d/3.9.0a1.rst
@@ -5535,7 +5535,7 @@ Tyler Kieft.
.. nonce: d0bhEA
.. section: C API
-:c:func:`Py_SetPath` now sets :data:`sys.executable` to the program full
+:c:func:`!Py_SetPath` now sets :data:`sys.executable` to the program full
path (:c:func:`Py_GetProgramFullPath`) rather than to the program name
(:c:func:`Py_GetProgramName`).
@@ -5546,8 +5546,8 @@ path (:c:func:`Py_GetProgramFullPath`) rather than to the program name
.. nonce: ZbquVK
.. section: C API
-Python ignored arguments passed to :c:func:`Py_SetPath`,
-:c:func:`Py_SetPythonHome` and :c:func:`Py_SetProgramName`: fix Python
+Python ignored arguments passed to :c:func:`!Py_SetPath`,
+:c:func:`!Py_SetPythonHome` and :c:func:`!Py_SetProgramName`: fix Python
initialization to use specified arguments.
..
diff --git a/Misc/NEWS.d/3.9.0a5.rst b/Misc/NEWS.d/3.9.0a5.rst
index 8a12195..19ad20a 100644
--- a/Misc/NEWS.d/3.9.0a5.rst
+++ b/Misc/NEWS.d/3.9.0a5.rst
@@ -1234,8 +1234,8 @@ method name in the SystemError "bad call flags" error message to ease debug.
.. nonce: GOYtIm
.. section: C API
-Deprecated :c:func:`PyEval_InitThreads` and
-:c:func:`PyEval_ThreadsInitialized`. Calling :c:func:`PyEval_InitThreads`
+Deprecated :c:func:`!PyEval_InitThreads` and
+:c:func:`!PyEval_ThreadsInitialized`. Calling :c:func:`!PyEval_InitThreads`
now does nothing.
..