Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) #97775

Merged
merged 2 commits into from
Oct 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/c-api/file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ the :mod:`io` APIs instead.
Overrides the normal behavior of :func:`io.open_code` to pass its parameter
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`.

The *userData* pointer is passed into the hook function. Since hook
Expand Down
6 changes: 3 additions & 3 deletions Doc/c-api/structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ the definition of all other Python objects.

.. versionchanged:: 3.11
: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)
Expand All @@ -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.

.. 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
:c:func:`Py_REFCNT()` is changed to the inline static function.
Expand All @@ -149,7 +149,7 @@ the definition of all other Python objects.

.. versionchanged:: 3.11
: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)
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/2.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
: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.)

* A new function, ``PyTuple_Pack(N, obj1, obj2, ..., objN)``, constructs
Expand All @@ -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.
(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.)

* C code can avoid unnecessary locking by using the new
Expand Down
2 changes: 1 addition & 1 deletion Misc/NEWS.d/3.8.0a4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1354,7 +1354,7 @@ the function is called twice.
.. nonce: pz-DIR
.. 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
Inada Naoki.

Expand Down