cpython/Doc/c-api
Peter Bierma 35528fccdc
gh-141004: Document missing iterator types in the C API (GH-141010)
Add documentation for each of the following:

- PyByteArrayIter_Type
- PyBytesIter_Type
- PyListIter_Type
- PyListRevIter_Type
- PySetIter_Type
- PyTupleIter_Type
- PyRangeIter_Type
- PyLongRangeIter_Type
- PyDictIterKey_Type
- PyDictRevIterKey_Type
- PyDictIterValue_Type
- PyDictRevIterValue_Type
- PyDictIterItem_Type
- PyDictRevIterItem_Type

---------

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2025-11-05 09:13:57 -05:00
..
abstract.rst gh-85275: Remove old buffer APIs (#105137) 2023-06-02 01:12:40 +00:00
allocation.rst gh-134160: Use multi-phase init in documentation examples (#134296) 2025-05-26 21:43:35 +00:00
apiabiversion.rst gh-128629: Add Py_PACK_VERSION and Py_PACK_FULL_VERSION (GH-128630) 2025-01-09 11:10:28 +01:00
arg.rst Docs: Fix a grammatical error in Doc/c-api/arg.rst (GH-140525) 2025-10-24 08:17:52 -04:00
bool.rst gh-110481, doc: Add "immortal" term to the glossary (#112180) 2023-11-17 15:09:19 +01:00
buffer.rst gh-132246: Add PEP 688 to C Buffer Protocol docs (#132249) 2025-04-08 10:43:27 -07:00
bytearray.rst Python 3.14.0a5 2025-02-11 19:16:29 +02:00
bytes.rst gh-129813: Enhance PyBytesWriter documentation (#140152) 2025-10-15 14:54:18 +02:00
call.rst Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET (#110963) 2023-10-23 19:00:52 +03:00
capsule.rst Docs: Fix a grammatical error in Doc/c-api/capsule.rst (GH-140577) 2025-10-25 09:54:52 -04:00
cell.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
code.rst Fix typo in Doc/c-api/code.rst (#140586) 2025-10-25 17:34:45 +02:00
codec.rst Docs: Replace "encoder" with "decoder" in Doc/c-api/codec.rst (#140613) 2025-10-27 10:43:24 +01:00
complex.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
concrete.rst GH-97950: Use new-style index directive ('object') (#104158) 2023-05-04 13:04:41 +03:00
contextvars.rst gh-124872: Replace enter/exit events with "switched" (#125532) 2024-10-16 13:53:21 +02:00
conversion.rst Docs: avoid informal formulation in Doc/c-api/conversion.rst (#140898) 2025-11-02 13:49:49 +00:00
coro.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
datetime.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
descriptor.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
dict.rst Docs: fix some grammatical errors in Doc/c-api/dict.rst (#140899) 2025-11-02 09:31:26 +01:00
exceptions.rst gh-136209: Add .. c:var:: declarations for C exception types (GH-136210) 2025-07-10 13:07:55 +02:00
extension-modules.rst Docs: Remove unnecessary trailing backslashes (GH-135781) 2025-06-21 09:01:14 -04:00
file.rst gh-115172: Fix explicit index extries for the C API (GH-115173) 2024-02-11 12:23:30 +02:00
float.rst gh-136663: fix signatures of PyFloat_Pack/Unpack in docs (#136664) 2025-07-15 11:00:12 +05:30
frame.rst gh-118915: C API: Document frame locals proxies. (#127720) 2024-12-11 17:28:44 +01:00
function.rst gh-139924: Add PyFunction_PYFUNC_EVENT_MODIFY_QUALNAME event for function watchers (#139925) 2025-10-10 15:25:38 -07:00
gcsupport.rst gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
gen.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
hash.rst Fix documentation of hash in PyHash_FuncDef (#137595) 2025-08-11 13:18:37 +02:00
import.rst gh-133644: remove deprecated PyImport_ImportModuleNoBlock (#133655) 2025-05-08 13:08:43 +00:00
index.rst gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) 2025-06-13 16:39:35 +02:00
init.rst Fix typo in TLS docs (#140640) 2025-10-27 10:28:30 +05:30
init_config.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
intro.rst gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) 2025-06-13 16:39:35 +02:00
iter.rst Fix typo in PyIter_Send docs (#140336) 2025-10-20 14:23:57 +05:30
iterator.rst gh-141004: Document missing iterator types in the C API (GH-141010) 2025-11-05 09:13:57 -05:00
lifecycle.dot gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
lifecycle.dot.css gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
lifecycle.dot.pdf gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
lifecycle.dot.svg gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
lifecycle.rst Remove newline in Doc/c-api/lifecycle.rst for gettext builder (GH-135013) 2025-06-02 21:13:08 +03:00
list.rst gh-121403: Add notes for PyList_GetXXX APIs about the need for init (gh-121626) 2024-07-16 10:16:41 +09:00
long.rst gh-133059: Update documentation of preallocated integer range in long.rst (GH-140231) 2025-10-17 06:32:02 -04:00
mapping.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
marshal.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
memory.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
memoryview.rst gh-101100: Fix sphinx warnings in Doc/c-api/memoryview.rst (GH-114669) 2024-01-29 11:56:11 +02:00
method.rst gh-107091: Fix the use of some C domain roles (#107092) 2023-07-23 12:27:05 +02:00
module.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
monitoring.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
none.rst gh-110481, doc: Add "immortal" term to the glossary (#112180) 2023-11-17 15:09:19 +01:00
number.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
object.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
objimpl.rst gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962) 2025-05-20 14:25:50 +02:00
perfmaps.rst gh-136459: Add perf trampoline support for macOS (#136461) 2025-07-22 16:47:24 +01:00
refcounting.rst Docs: Fix markups for emphasis (GH-135598) 2025-06-18 13:32:43 -04:00
reflection.rst gh-127989: C API: Refer to "attached thread states" instead of the GIL (GH-127990) 2025-03-20 13:06:59 +01:00
sequence.rst gh-127896: Add missing documentation of PySequence_In (GH-127979) 2024-12-16 14:56:04 +01:00
set.rst gh-101100: Fix Sphinx reference warnings (GH-112416) 2023-11-25 15:40:19 -08:00
slice.rst gh-130214: Document PyEllipsis_Type (GH-130215) 2025-02-17 13:56:33 +01:00
stable.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
structures.rst gh-135913: Document ob_refcnt, ob_type, ob_size (GH-135914) 2025-07-07 14:05:17 +02:00
sys.rst Python 3.15.0a1 2025-10-14 13:46:08 +03:00
time.rst gh-127989: C API: Refer to "attached thread states" instead of the GIL (GH-127990) 2025-03-20 13:06:59 +01:00
tuple.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
type.rst Document that PyType_GetModuleByDef returns a borrowed reference (GH-135666) 2025-06-19 09:00:41 +02:00
typehints.rst gh-107298: Fix Sphinx warnings in the C API doc (#107302) 2023-07-27 01:41:15 +02:00
typeobj.rst gh-138189: Document type slots, and other constants, as part of Limited API (GH-138190) 2025-11-04 22:58:53 +01:00
unicode.rst gh-141004: Document Py_UNICODE_{HIGH, LOW}_SURROGATE functions (GH-141019) 2025-11-04 16:19:06 -05:00
utilities.rst gh-110850: Add PyTime_t C API (GH-115215) 2024-02-12 18:13:10 +01:00
veryhigh.rst Fix minor typos and wording in C API docs (#140955) 2025-11-03 22:04:46 +02:00
weakref.rst gh-133644: remove PyWeakref_GetObject and PyWeakref_GET_OBJECT (GH-133657) 2025-09-24 11:25:56 +02:00