cpython/Doc/c-api
Miss Islington (bot) b1c148c1be
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.

(cherry picked from commit 219696abb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2022-11-28 03:26:05 -08:00
..
abstract.rst bpo-41103: Resurrect the old buffer protocol. (GH-27437) (GH-27441) 2021-07-29 13:31:42 +02:00
allocation.rst [3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558) 2022-07-05 14:30:37 +02:00
apiabiversion.rst bpo-43795: PEP 652 user documentation (GH-25668) (GH-26034) 2021-05-13 22:29:09 -07:00
arg.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
bool.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
buffer.rst Fix types in buffer/memoryview docs (GH-98118) 2022-10-09 18:02:49 -07:00
bytearray.rst More minor fixes to C API docs (GH-31714) 2022-04-02 12:54:04 -07:00
bytes.rst Document Py_ssize_t. (GH-92512) 2022-05-13 06:32:39 -07:00
call.rst [3.10] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97888) 2022-10-05 08:17:46 -07:00
capsule.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
cell.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
code.rst Document PyCode_Addr2Line function. (GH-25111) 2021-04-02 13:24:57 +01:00
codec.rst bpo-41842: Add codecs.unregister() function (GH-22360) 2020-09-28 23:41:11 +02:00
complex.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
concrete.rst bpo-44392: Add Py_GenericAlias to C API docs (GH-26724) 2021-06-16 07:34:45 -07: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 Add a warning message about PyOS_snprintf (GH-95993) 2022-10-07 13:36:21 -07: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-13 17:51:03 -07:00
descriptor.rst bpo-40170: Convert PyDescr_IsData() to static inline function (GH-24535) 2021-02-16 08:50:00 +01:00
dict.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
exceptions.rst [3.10] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97911) 2022-10-05 11:00:50 -07:00
file.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
float.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
function.rst bpo-42990: Refactor _PyFrame_New_NoTrack() (GH-24566) 2021-02-18 19:20:16 +01:00
gcsupport.rst [3.10] bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) (GH-29249) 2021-10-28 21:22:57 +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
import.rst [3.10] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97893) 2022-10-05 08:20:46 -07:00
index.rst bpo-36763: Implement the PEP 587 (GH-13592) 2019-05-27 16:39:22 +02:00
init.rst [3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373) 2022-10-18 01:49:47 +02:00
init_config.rst Doc: Replace question mark with fullstop (GH-99558) 2022-11-18 11:34:17 -08:00
intro.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
iter.rst [3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 2022-04-02 16:00:51 -07:00
iterator.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
list.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
long.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
mapping.rst [3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 2022-04-02 16:00:51 -07:00
marshal.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
memory.rst gh-96997: Clarify the contract of PyMem_SetAllocator() (GH-98977) 2022-11-02 14:56:14 -07:00
memoryview.rst Fix types in buffer/memoryview docs (GH-98118) 2022-10-09 18:02:49 -07:00
method.rst [3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 2022-04-02 16:00:51 -07:00
module.rst [3.10] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97911) 2022-10-05 11:00:50 -07:00
none.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
number.rst Document Py_ssize_t. (GH-92512) 2022-05-13 06:32:39 -07:00
objbuffer.rst bpo-41103: Resurrect the old buffer protocol. (GH-27437) (GH-27441) 2021-07-29 13:31:42 +02:00
object.rst [3.10] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97890) 2022-10-05 08:21:18 -07:00
objimpl.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
refcounting.rst gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805) 2022-05-18 02:00:00 -07:00
reflection.rst bpo-40421: Fix PyFrame_GetCode() documentation (GH-31535) 2022-02-23 11:12:51 -08:00
sequence.rst [3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 2022-04-02 16:00:51 -07:00
set.rst [3.10] More minor fixes to C API docs (GH-31525) (GH-32258) 2022-04-02 16:00:51 -07:00
slice.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
stable.rst Reword paragraph on specific value for Py_LIMITED_API (GH-26101) (GH-26123) 2021-05-14 14:28:08 +02:00
structures.rst [3.10] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) (GH-97775) (#97891) 2022-10-05 08:19:38 -07:00
sys.rst [3.10] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97925) 2022-10-05 14:10:55 -07:00
tuple.rst [3.10] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97888) 2022-10-05 08:17:46 -07:00
type.rst [3.10] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98373) 2022-10-18 01:49:47 +02:00
typehints.rst [3.10] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97890) 2022-10-05 08:21:18 -07:00
typeobj.rst gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) 2022-11-28 03:26:05 -08:00
unicode.rst [3.10] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97977) 2022-10-06 11:56:52 -07:00
utilities.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
veryhigh.rst [3.10] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97893) 2022-10-05 08:20:46 -07:00
weakref.rst [3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558) 2022-07-05 14:30:37 +02:00