cpython/Doc/c-api
Petr Viktorin 219696abb2
gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342)
These slots are marked "should be treated as read-only" in the
table at the start of the document.  That doesn't say anything about
setting them in the static struct.

`tp_bases` docs did say that it should be ``NULL`` (TIL!). If you
ignore that, seemingly nothing bad happens. However, some slots
may not be inherited, depending on which sub-slot structs are present.
(FWIW, NumPy sets tp_bases and is affected by the quirk -- though to
be fair, its DUAL_INHERIT code probably predates tp_bases docs, and
also the result happens to be benign.)

This patch makes things explicit.
It also makes the summary table legend easier to scan.

Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 09:22:08 +01:00
..
abstract.rst
allocation.rst
apiabiversion.rst
arg.rst
bool.rst
buffer.rst Fix types in buffer/memoryview docs (#98118) 2022-10-09 17:55:53 -07:00
bytearray.rst
bytes.rst
call.rst gh-98586: Add What's New entry and update docs (#99056) 2022-11-06 23:54:55 +01:00
capsule.rst
cell.rst
code.rst
codec.rst
complex.rst
concrete.rst
contextvars.rst
conversion.rst Add a warning message about PyOS_snprintf (#95993) 2022-10-07 11:49:53 -07:00
coro.rst
datetime.rst
descriptor.rst
dict.rst gh-91052: Add PyDict_Unwatch for unwatching a dictionary (#98055) 2022-10-07 17:37:46 -07:00
exceptions.rst
file.rst
float.rst
frame.rst gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695) 2022-11-22 16:41:57 +01:00
function.rst gh-91053: Add an optional callback that is invoked whenever a function is modified (#98175) 2022-11-22 13:06:44 +01:00
gcsupport.rst
gen.rst
import.rst gh-65961: Do not rely solely on __cached__ (GH-97990) 2022-10-06 15:40:22 -07:00
index.rst
init.rst gh-99377: Revert audit events for thread state creation and free, because the GIL is not properly held at these times (GH-99543) 2022-11-17 00:24:16 +00:00
init_config.rst Doc: Replace question mark with fullstop (#99558) 2022-11-18 11:24:23 -08:00
intro.rst
iter.rst
iterator.rst
list.rst
long.rst
mapping.rst
marshal.rst
memory.rst gh-96997: Clarify the contract of PyMem_SetAllocator() (#98977) 2022-11-02 21:49:12 +00:00
memoryview.rst Fix types in buffer/memoryview docs (#98118) 2022-10-09 17:55:53 -07:00
method.rst
module.rst
none.rst
number.rst
objbuffer.rst
object.rst
objimpl.rst
refcounting.rst Revert "gh-98724: Fix Py_CLEAR() macro side effects" (#99737) 2022-11-24 22:17:33 +01:00
reflection.rst
sequence.rst
set.rst
slice.rst
stable.rst
structures.rst gh-47146: Soft-deprecate structmember.h, expose its contents via Python.h (GH-99014) 2022-11-22 08:25:43 +01:00
sys.rst
tuple.rst no-issue: typo fix in c-api/tuple.rst (gh-98560) 2022-10-23 19:46:56 +09:00
type.rst gh-91051: allow setting a callback hook on PyType_Modified (GH-97875) 2022-10-21 14:41:51 +01:00
typehints.rst
typeobj.rst gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) 2022-11-28 09:22:08 +01:00
unicode.rst
utilities.rst
veryhigh.rst
weakref.rst