mirror of
https://github.com/python/cpython.git
synced 2025-11-24 20:30:18 +00:00
[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
This commit is contained in:
parent
09c890ec8c
commit
25a2a60371
12 changed files with 13 additions and 13 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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`,
|
||||
|
|
|
|||
|
|
@ -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`
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
||||
|
|
|
|||
|
|
@ -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`.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -48,7 +48,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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue