C-API documentation ignores heap types and says type objects must never be deallocated

[koubaa]

BPO	41790
Nosy	@koubaa
PRs	bpo-41790: update error in documentation #22242

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-09-15.03:15:13.517>
labels = ['type-bug', '3.10', 'docs']
title = 'C-API documentation ignores heap types and says type objects must never be deallocated'
updated_at = <Date 2020-09-15.16:51:11.709>
user = 'https://github.com/koubaa'

bugs.python.org fields:

activity = <Date 2020-09-15.16:51:11.709>
actor = 'ammar2'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-09-15.03:15:13.517>
creator = 'koubaa'
dependencies = []
files = []
hgrepos = []
issue_num = 41790
keywords = []
message_count = 1.0
messages = ['376926']
nosy_count = 2.0
nosy_names = ['docs@python', 'koubaa']
pr_nums = ['22242']
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue41790'
versions = ['Python 3.10']

[koubaa]

The C-API documentation introduction contains an error:

"Almost all Python objects live on the
heap: you never declare an automatic or static variable of type
:c:type:`PyObject`, only pointer variables of type :c:type:`PyObject*` can be
declared. The sole exception are the type objects; since these must never be
deallocated, they are typically static :c:type:`PyTypeObject` objects."

With heap types, PyTypeObject can be deallocated.