mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-21 09:21:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

[3.11] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) (GH-97775) (#97873)

Browse source 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2022-10-05 08:18:55 -07:00 • committed by GitHub
parent 0a2008037f
commit ffafd31975
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/c-api/file.rst
View file

@ -65,7 +65,7 @@ the :mod:`io` APIs instead.
Overrides the normal behavior of :func:`io.open_code` to pass its parameter Overrides the normal behavior of :func:`io.open_code` to pass its parameter
through the provided handler. through the provided handler.
The handler is a function of type :c:type:`PyObject *(\*)(PyObject *path, The handler is a function of type :c:expr:`PyObject *(\*)(PyObject *path,
void *userData)`, where *path* is guaranteed to be :c:type:`PyUnicodeObject`. void *userData)`, where *path* is guaranteed to be :c:type:`PyUnicodeObject`.
The *userData* pointer is passed into the hook function. Since hook The *userData* pointer is passed into the hook function. Since hook

6
Doc/c-api/structures.rst
View file

@ -103,7 +103,7 @@ the definition of all other Python objects.
.. versionchanged:: 3.11 .. versionchanged:: 3.11
:c:func:`Py_TYPE()` is changed to an inline static function. :c:func:`Py_TYPE()` is changed to an inline static function.
The parameter type is no longer :c:type:`const PyObject*`. The parameter type is no longer :c:expr:`const PyObject*`.
.. c:function:: int Py_IS_TYPE(PyObject *o, PyTypeObject *type) .. c:function:: int Py_IS_TYPE(PyObject *o, PyTypeObject *type)
@ -128,7 +128,7 @@ the definition of all other Python objects.
Use the :c:func:`Py_SET_REFCNT()` function to set an object reference count. Use the :c:func:`Py_SET_REFCNT()` function to set an object reference count.
.. versionchanged:: 3.11 .. versionchanged:: 3.11
The parameter type is no longer :c:type:`const PyObject*`. The parameter type is no longer :c:expr:`const PyObject*`.
.. versionchanged:: 3.10 .. versionchanged:: 3.10
:c:func:`Py_REFCNT()` is changed to the inline static function. :c:func:`Py_REFCNT()` is changed to the inline static function.
@ -149,7 +149,7 @@ the definition of all other Python objects.
.. versionchanged:: 3.11 .. versionchanged:: 3.11
:c:func:`Py_SIZE()` is changed to an inline static function. :c:func:`Py_SIZE()` is changed to an inline static function.
The parameter type is no longer :c:type:`const PyVarObject*`. The parameter type is no longer :c:expr:`const PyVarObject*`.
.. c:function:: void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size) .. c:function:: void Py_SET_SIZE(PyVarObject *o, Py_ssize_t size)

4
Doc/whatsnew/2.4.rst
View file

@ -1453,7 +1453,7 @@ Some of the changes to Python's build process and to the C API are:
extension functions: :c:macro:`Py_RETURN_NONE`, :c:macro:`Py_RETURN_TRUE`, and extension functions: :c:macro:`Py_RETURN_NONE`, :c:macro:`Py_RETURN_TRUE`, and
:c:macro:`Py_RETURN_FALSE`. (Contributed by Brett Cannon.) :c:macro:`Py_RETURN_FALSE`. (Contributed by Brett Cannon.)
* Another new macro, :c:macro:`Py_CLEAR(obj)`, decreases the reference count of * Another new macro, :c:macro:`Py_CLEAR`, decreases the reference count of
*obj* and sets *obj* to the null pointer. (Contributed by Jim Fulton.) *obj* and sets *obj* to the null pointer. (Contributed by Jim Fulton.)
* A new function, ``PyTuple_Pack(N, obj1, obj2, ..., objN)``, constructs * A new function, ``PyTuple_Pack(N, obj1, obj2, ..., objN)``, constructs
@ -1464,7 +1464,7 @@ Some of the changes to Python's build process and to the C API are:
lookups without masking exceptions raised during the look-up process. lookups without masking exceptions raised during the look-up process.
(Contributed by Raymond Hettinger.) (Contributed by Raymond Hettinger.)
* The :c:macro:`Py_IS_NAN(X)` macro returns 1 if its float or double argument * The :c:expr:`Py_IS_NAN(X)` macro returns 1 if its float or double argument
*X* is a NaN. (Contributed by Tim Peters.) *X* is a NaN. (Contributed by Tim Peters.)
* C code can avoid unnecessary locking by using the new * C code can avoid unnecessary locking by using the new

2
Misc/NEWS.d/3.8.0a4.rst
View file

@ -1354,7 +1354,7 @@ the function is called twice.
.. nonce: pz-DIR .. nonce: pz-DIR
.. section: C API .. section: C API
:c:macro:`PyDoc_VAR(name)` and :c:macro:`PyDoc_STRVAR(name,str)` now create :c:expr:`PyDoc_VAR(name)` and :c:expr:`PyDoc_STRVAR(name,str)` now create
``static const char name[]`` instead of ``static char name[]``. Patch by ``static const char name[]`` instead of ``static char name[]``. Patch by
Inada Naoki. Inada Naoki.