cpython/Doc/c-api
Eric Snow 5dc825d504
gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552)
PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts.  In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.

This change updates the documentation to reflect that perspective.  It also updates the docs relative to immortal objects in a handful of places.
2023-08-07 15:40:59 -06:00
..
abstract.rst gh-85275: Remove old buffer APIs (#105137) 2023-06-02 01:12:40 +00:00
allocation.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
apiabiversion.rst gh-107298: Fix Sphinx warnings in the C API doc (#107302) 2023-07-27 01:41:15 +02:00
arg.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
bool.rst gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) 2023-07-29 08:48:10 +03:00
buffer.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
bytearray.rst GH-97950: Use new-style index directive ('object') (#104158) 2023-05-04 13:04:41 +03:00
bytes.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
call.rst Fix PyVectorcall_Function doc versionadded (#107140) 2023-07-24 14:54:38 +02:00
capsule.rst gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) 2023-07-27 18:44:32 +03:00
cell.rst gh-107298: Fix Sphinx warnings in the C API doc (#107302) 2023-07-27 01:41:15 +02:00
code.rst Fix the documentation for PyCode_New add `qualname` parameter (#107186) 2023-07-29 23:11:40 +05:30
codec.rst gh-107298: Fix doc references to undocumented modules (#107300) 2023-07-26 18:59:06 +02:00
complex.rst gh-107298: Fix more Sphinx warnings in the C API doc (#107329) 2023-07-27 00:52:40 +00:00
concrete.rst GH-97950: Use new-style index directive ('object') (#104158) 2023-05-04 13:04:41 +03:00
contextvars.rst bpo-43959: clarify the documentation of the PyContextVar C-API (GH-25671) 2021-04-28 07:03:19 -07:00
conversion.rst gh-107298: Fix more Sphinx warnings in the C API doc (#107329) 2023-07-27 00:52:40 +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 gh-90359: Unify documentation style for datetime.rst (gh-94836) 2022-07-14 09:40:10 +09:00
descriptor.rst bpo-40170: Convert PyDescr_IsData() to static inline function (GH-24535) 2021-02-16 08:50:00 +01:00
dict.rst gh-106004: Add PyDict_GetItemRef() function (#106005) 2023-07-21 23:10:51 +02:00
exceptions.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
file.rst gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) 2023-07-21 10:52:07 +03:00
float.rst gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) 2023-07-21 10:52:07 +03:00
frame.rst gh-105196: Fix indentations of section headings in C API docs (#105672) 2023-06-14 15:21:30 +01:00
function.rst GH-97950: Use new-style index directive ('object') (#104158) 2023-05-04 13:04:41 +03:00
gcsupport.rst gh-107298: Fix more Sphinx warnings in the C API doc (#107329) 2023-07-27 00:52:40 +00: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
import.rst gh-107091: Fix some uses of :attr: role (GH-107318) 2023-07-27 08:52:54 +03:00
index.rst bpo-36763: Implement the PEP 587 (GH-13592) 2019-05-27 16:39:22 +02:00
init.rst gh-107306: Add a Doc Entry for Py_mod_multiple_interpreters (#107403) 2023-07-31 17:03:01 -06:00
init_config.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
intro.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
iter.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -07:00
iterator.rst gh-107298: Fix Sphinx warnings in the C API doc (#107302) 2023-07-27 01:41:15 +02:00
list.rst gh-106168: PyTuple_SET_ITEM() now checks the index (#106164) 2023-06-28 03:45:57 +02:00
long.rst gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) 2023-07-21 10:52:07 +03:00
mapping.rst gh-101100: Fix some broken sphinx references (#107095) 2023-07-23 03:23:44 -06:00
marshal.rst gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (#105185) 2023-06-02 08:59:18 +01:00
memory.rst gh-105766: Document that Custom Allocators Must Be Thread-Safe (gh-107519) 2023-07-31 23:11:15 +00:00
memoryview.rst GH-97950: Use new-style index directive ('object') (#104158) 2023-05-04 13:04:41 +03:00
method.rst gh-107091: Fix the use of some C domain roles (#107092) 2023-07-23 12:27:05 +02:00
module.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
none.rst gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) 2023-07-27 18:44:32 +03:00
number.rst GH-97950: Use new-style index directive ('builtin') (#104164) 2023-05-06 06:54:08 +03:00
object.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
objimpl.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
perfmaps.rst gh-103295: expose API for writing perf map files (#103546) 2023-05-21 11:12:24 +01:00
refcounting.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
reflection.rst bpo-46836: Add Doc/c-api/frame.rst (GH-32051) 2022-03-23 13:19:13 +01:00
sequence.rst gh-101100: Fix some broken sphinx references (#107095) 2023-07-23 03:23:44 -06:00
set.rst gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) 2023-07-27 18:44:32 +03:00
slice.rst gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) 2023-07-21 10:52:07 +03:00
stable.rst gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) 2023-07-21 10:52:07 +03:00
structures.rst gh-107091: Fix some uses of :attr: role (GH-107318) 2023-07-27 08:52:54 +03:00
sys.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
tuple.rst gh-107298: Docs: add targets for some :c:member: and :c:macro: references (GH-107316) 2023-07-27 09:04:02 +03:00
type.rst gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345) 2023-07-27 18:44:32 +03: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-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
unicode.rst gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107552) 2023-08-07 15:40:59 -06:00
utilities.rst gh-103295: expose API for writing perf map files (#103546) 2023-05-21 11:12:24 +01:00
veryhigh.rst gh-107091: Fix some uses of :attr: role (GH-107318) 2023-07-27 08:52:54 +03:00
weakref.rst gh-105927: PyWeakref_GetRef() returns 1 on success (#106561) 2023-07-09 15:50:26 +00:00