mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-23 10:16:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
cpython/Doc/c-api
History
Miss Islington (bot) 5dce4ab736
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:25:04 -08:00
..
abstract.rst bpo-41103: Resurrect the old buffer protocol. (GH-27437) 2021-07-29 12:46:47 +02:00
allocation.rst Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557) 2022-07-05 14:30:19 +02:00
apiabiversion.rst Doc: some rst linting. (GH-30149) 2021-12-17 13:55:03 +01:00
arg.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -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:03:53 -07:00
bytearray.rst gh-89653: PEP 670: Convert PyBytes macros to functions (#91990) 2022-05-03 20:14:58 +02:00
bytes.rst Document Py_ssize_t. (GH-92512) 2022-05-13 06:32:05 -07:00
call.rst [3.11] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97889) 2022-10-05 08:18:27 -07:00
capsule.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -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 gh-95913: Fix and copyedit New Features section of 3.11 What's New (GH-95915) 2022-09-19 06:45:35 -07:00
codec.rst bpo-41842: Add codecs.unregister() function (GH-22360) 2020-09-28 23:41:11 +02:00
complex.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
concrete.rst bpo-46836: Add Doc/c-api/frame.rst (GH-32051) 2022-03-23 13:19:13 +01: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:26:46 -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 [3.11] gh-90359: Unify documentation style for datetime.rst (gh-94836) (gh-94838) 2022-07-14 09:52:53 +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 [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
exceptions.rst [3.11] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97910) 2022-10-05 11:00:29 -07:00
file.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
float.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
frame.rst gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695) 2022-11-22 07:50:39 -08:00
function.rst bpo-44530: Add co_qualname field to PyCodeObject (GH-26941) 2021-07-07 12:21:51 +01:00
gcsupport.rst bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) 2021-10-27 21:15:13 +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.11] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97869) 2022-10-05 08:20:03 -07:00
index.rst bpo-36763: Implement the PEP 587 (GH-13592) 2019-05-27 16:39:22 +02:00
init.rst [3.11] Docs: Bump sphinx-lint and use double backticks for inline literals (GH-98441) (#98445) 2022-10-20 06:07:33 -07:00
init_config.rst Doc: Replace question mark with fullstop (GH-99558) 2022-11-18 11:34:10 -08:00
intro.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
iter.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -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 gh-89653: PEP 670: Amend docs (GH-91813) 2022-04-22 14:59:18 +02:00
long.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
mapping.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -07:00
marshal.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
memory.rst gh-96997: Clarify the contract of PyMem_SetAllocator() (GH-98977) 2022-11-02 14:57:26 -07:00
memoryview.rst Fix types in buffer/memoryview docs (GH-98118) 2022-10-09 18:03:53 -07:00
method.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -07:00
module.rst [3.11] gh-93738: Documentation C syntax (Function glob patterns -> literal markup) (GH-97774) (#97910) 2022-10-05 11:00:29 -07:00
none.rst
number.rst Document Py_ssize_t. (GH-92512) 2022-05-13 06:32:05 -07:00
objbuffer.rst bpo-41103: Resurrect the old buffer protocol. (GH-27437) 2021-07-29 12:46:47 +02:00
object.rst [3.11] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97892) 2022-10-05 08:21:32 -07:00
objimpl.rst
refcounting.rst gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805) 2022-05-18 02:00:22 -07:00
reflection.rst bpo-46836: Add Doc/c-api/frame.rst (GH-32051) 2022-03-23 13:19:13 +01:00
sequence.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -07:00
set.rst More minor fixes to C API docs (GH-31525) 2022-04-02 12:31:05 -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) 2021-05-13 22:22:44 -07:00
structures.rst [3.11] gh-93738: Documentation C syntax (:c:type: to :c:expr:, misc. cases) (GH-97775) (#97873) 2022-10-05 08:18:55 -07:00
sys.rst [3.11] gh-93738: Documentation C syntax (:c:type:<C type> -> :c:expr:<C type>) (GH-97768) (#97924) 2022-10-05 14:11:12 -07:00
tuple.rst [3.11] gh-93738: Documentation C syntax (:c:type:PyObject -> :c:expr:PyObject) (GH-97776) (#97889) 2022-10-05 08:18:27 -07:00
type.rst [3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371) 2022-10-18 01:49:38 +02:00
typehints.rst [3.11] gh-93738: Documentation C syntax (:c:type:PyTypeObject* -> :c:expr:PyTypeObject*) (GH-97778) (#97892) 2022-10-05 08:21:32 -07:00
typeobj.rst gh-99249: Clarify "read-only" slots tp_bases & tp_mro (GH-99342) 2022-11-28 03:25:04 -08:00
unicode.rst [3.11] gh-93738: Disallow pre-v3 syntax in the C domain (GH-97962) (#97976) 2022-10-06 10:49:29 -07:00
utilities.rst
veryhigh.rst [3.11] gh-93738: Documentation C syntax (Use c:struct) (GH-97772) (#97869) 2022-10-05 08:20:03 -07:00
weakref.rst Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94557) 2022-07-05 14:30:19 +02:00