https://github.com/python/cpython/commit/3f2b83e9595ff2436a646e6bbd335198c4bc06db
commit: 3f2b83e9595ff2436a646e6bbd335198c4bc06db
branch: main
author: Petr Viktorin <[email protected]>
committer: hugovk <[email protected]>
date: 2025-11-03T22:04:46+02:00
summary:
Fix minor typos and wording in C API docs (#140955)
files:
M Doc/c-api/cell.rst
M Doc/c-api/complex.rst
M Doc/c-api/datetime.rst
M Doc/c-api/descriptor.rst
M Doc/c-api/init_config.rst
M Doc/c-api/mapping.rst
M Doc/c-api/marshal.rst
M Doc/c-api/memory.rst
M Doc/c-api/module.rst
M Doc/c-api/monitoring.rst
M Doc/c-api/object.rst
M Doc/c-api/stable.rst
M Doc/c-api/tuple.rst
M Doc/c-api/veryhigh.rst
diff --git a/Doc/c-api/cell.rst b/Doc/c-api/cell.rst
index 61eb994c370946..2501ed9580df89 100644
--- a/Doc/c-api/cell.rst
+++ b/Doc/c-api/cell.rst
@@ -7,7 +7,7 @@ Cell Objects
"Cell" objects are used to implement variables referenced by multiple scopes.
For each such variable, a cell object is created to store the value; the local
-variables of each stack frame that references the value contains a reference to
+variables of each stack frame that references the value contain a reference to
the cells from outer scopes which also use that variable. When the value is
accessed, the value contained in the cell is used instead of the cell object
itself. This de-referencing of the cell object requires support from the
diff --git a/Doc/c-api/complex.rst b/Doc/c-api/complex.rst
index d135637a7417ab..629312bd771beb 100644
--- a/Doc/c-api/complex.rst
+++ b/Doc/c-api/complex.rst
@@ -82,7 +82,7 @@ Complex Number Objects
.. c:type:: Py_complex
- This C structure defines export format for a Python complex
+ This C structure defines an export format for a Python complex
number object.
.. c:member:: double real
diff --git a/Doc/c-api/datetime.rst b/Doc/c-api/datetime.rst
index d2d4d5309c7098..f311aad5f15499 100644
--- a/Doc/c-api/datetime.rst
+++ b/Doc/c-api/datetime.rst
@@ -46,7 +46,7 @@ macros.
.. c:var:: PyTypeObject PyDateTime_DeltaType
- This instance of :c:type:`PyTypeObject` represents Python type for
+ This instance of :c:type:`PyTypeObject` represents the Python type for
the difference between two datetime values;
it is the same object as :class:`datetime.timedelta` in the Python layer.
diff --git a/Doc/c-api/descriptor.rst b/Doc/c-api/descriptor.rst
index b32c113e5f0457..ff0df575279d96 100644
--- a/Doc/c-api/descriptor.rst
+++ b/Doc/c-api/descriptor.rst
@@ -32,7 +32,7 @@ found in the dictionary of type objects.
.. c:function:: int PyDescr_IsData(PyObject *descr)
- Return non-zero if the descriptor objects *descr* describes a data
attribute, or
+ Return non-zero if the descriptor object *descr* describes a data
attribute, or
``0`` if it describes a method. *descr* must be a descriptor object; there
is
no error checking.
diff --git a/Doc/c-api/init_config.rst b/Doc/c-api/init_config.rst
index b20495e672dd75..c345029e4acd49 100644
--- a/Doc/c-api/init_config.rst
+++ b/Doc/c-api/init_config.rst
@@ -102,7 +102,7 @@ Error Handling
* Set *\*err_msg* and return ``1`` if an error is set.
* Set *\*err_msg* to ``NULL`` and return ``0`` otherwise.
- An error message is an UTF-8 encoded string.
+ An error message is a UTF-8 encoded string.
If *config* has an exit code, format the exit code as an error
message.
diff --git a/Doc/c-api/mapping.rst b/Doc/c-api/mapping.rst
index 1f55c0aa955c75..2476ebb9b69dce 100644
--- a/Doc/c-api/mapping.rst
+++ b/Doc/c-api/mapping.rst
@@ -102,7 +102,7 @@ See also :c:func:`PyObject_GetItem`,
:c:func:`PyObject_SetItem` and
.. note::
- Exceptions which occur when this calls :meth:`~object.__getitem__`
+ Exceptions which occur when this calls the :meth:`~object.__getitem__`
method are silently ignored.
For proper error handling, use :c:func:`PyMapping_HasKeyWithError`,
:c:func:`PyMapping_GetOptionalItem` or :c:func:`PyObject_GetItem()`
instead.
@@ -116,7 +116,7 @@ See also :c:func:`PyObject_GetItem`,
:c:func:`PyObject_SetItem` and
.. note::
- Exceptions that occur when this calls :meth:`~object.__getitem__`
+ Exceptions that occur when this calls the :meth:`~object.__getitem__`
method or while creating the temporary :class:`str`
object are silently ignored.
For proper error handling, use :c:func:`PyMapping_HasKeyStringWithError`,
diff --git a/Doc/c-api/marshal.rst b/Doc/c-api/marshal.rst
index 61218a1bf6f171..668a163b2df5a1 100644
--- a/Doc/c-api/marshal.rst
+++ b/Doc/c-api/marshal.rst
@@ -82,7 +82,7 @@ The following functions allow marshalled values to be read
back in.
assumes that no further objects will be read from the file, allowing it to
aggressively load file data into memory so that the de-serialization can
operate from data in memory rather than reading a byte at a time from the
- file. Only use these variant if you are certain that you won't be reading
+ file. Only use this variant if you are certain that you won't be reading
anything else from the file.
On error, sets the appropriate exception (:exc:`EOFError`, :exc:`ValueError`
diff --git a/Doc/c-api/memory.rst b/Doc/c-api/memory.rst
index df1bb0ce370919..2395898010214d 100644
--- a/Doc/c-api/memory.rst
+++ b/Doc/c-api/memory.rst
@@ -102,7 +102,7 @@ All allocating functions belong to one of three different
"domains" (see also
strategies and are optimized for different purposes. The specific details on
how every domain allocates memory or what internal functions each domain calls
is considered an implementation detail, but for debugging purposes a simplified
-table can be found at :ref:`here <default-memory-allocators>`.
+table can be found at :ref:`default-memory-allocators`.
The APIs used to allocate and free a block of memory must be from the same
domain.
For example, :c:func:`PyMem_Free` must be used to free memory allocated using
:c:func:`PyMem_Malloc`.
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index 6626f628fcc47f..ed2a7663375920 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -103,7 +103,7 @@ Module Objects
created, or ``NULL`` if the module wasn't created from a definition.
On error, return ``NULL`` with an exception set.
- Use :c:func:`PyErr_Occurred` to tell this case apart from a mising
+ Use :c:func:`PyErr_Occurred` to tell this case apart from a missing
:c:type:`!PyModuleDef`.
diff --git a/Doc/c-api/monitoring.rst b/Doc/c-api/monitoring.rst
index 7926148302af0b..b0227c2f4faf15 100644
--- a/Doc/c-api/monitoring.rst
+++ b/Doc/c-api/monitoring.rst
@@ -136,7 +136,7 @@ Managing the Monitoring State
-----------------------------
Monitoring states can be managed with the help of monitoring scopes. A scope
-would typically correspond to a python function.
+would typically correspond to a Python function.
.. c:function:: int PyMonitoring_EnterScope(PyMonitoringState *state_array,
uint64_t *version, const uint8_t *event_types, Py_ssize_t length)
diff --git a/Doc/c-api/object.rst b/Doc/c-api/object.rst
index 8629b768a2948e..96353266ac7300 100644
--- a/Doc/c-api/object.rst
+++ b/Doc/c-api/object.rst
@@ -73,7 +73,7 @@ Object Protocol
Flag to be used with multiple functions that print the object (like
:c:func:`PyObject_Print` and :c:func:`PyFile_WriteObject`).
- If passed, these function would use the :func:`str` of the object
+ If passed, these functions use the :func:`str` of the object
instead of the :func:`repr`.
diff --git a/Doc/c-api/stable.rst b/Doc/c-api/stable.rst
index b08a7bf1b2fa4f..f5e6b7ad157e99 100644
--- a/Doc/c-api/stable.rst
+++ b/Doc/c-api/stable.rst
@@ -279,7 +279,7 @@ The full API is described below for advanced use cases.
.. c:member:: uint8_t abiinfo_minor_version
- The major version of :c:struct:`PyABIInfo`.
+ The minor version of :c:struct:`PyABIInfo`.
Must be set to ``0``; larger values are reserved for backwards-compatible
future versions of :c:struct:`!PyABIInfo`.
diff --git a/Doc/c-api/tuple.rst b/Doc/c-api/tuple.rst
index 14a7c05efeac87..d0add48d7e8457 100644
--- a/Doc/c-api/tuple.rst
+++ b/Doc/c-api/tuple.rst
@@ -61,7 +61,7 @@ Tuple Objects
.. c:function:: Py_ssize_t PyTuple_Size(PyObject *p)
Take a pointer to a tuple object, and return the size of that tuple.
- On error, return ``-1`` and with an exception set.
+ On error, return ``-1`` with an exception set.
.. c:function:: Py_ssize_t PyTuple_GET_SIZE(PyObject *p)
diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
index ee0595a9e089c9..0b2b55b6387bd1 100644
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -140,7 +140,7 @@ the same library that the Python runtime is using.
interpreter prompt is about to become idle and wait for user input
from the terminal. The return value is ignored. Overriding this
hook can be used to integrate the interpreter's prompt with other
- event loops, as done in the :file:`Modules/_tkinter.c` in the
+ event loops, as done in :file:`Modules/_tkinter.c` in the
Python source code.
.. versionchanged:: 3.12
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
