C API: Allocating Objects on the Heap. Misleading documentation.
Open
Nobody has claimed this yet.
docs
topic-C-API
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 42292 |
|---|
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-11-08.18:21:38.587>
labels = ['type-feature', '3.8', '3.9', 'docs']
title = 'C API: Allocating Objects on the Heap. Misleading documentation.'
updated_at = <Date 2020-11-11.09:18:27.246>
user = 'https://bugs.python.org/igo95862'
bugs.python.org fields:
activity = <Date 2020-11-11.09:18:27.246>
actor = 'igo95862'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-11-08.18:21:38.587>
creator = 'igo95862'
dependencies = []
files = []
hgrepos = []
issue_num = 42292
keywords = []
message_count = 2.0
messages = ['380558', '380744']
nosy_count = 2.0
nosy_names = ['docs@python', 'igo95862']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue42292'
versions = ['Python 3.8', 'Python 3.9']
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue identifies the C API documentation about allocating objects on the heap but names no file, section, or test. Locate the relevant documentation entry, compare its heap-allocation guidance with the C API behavior, and confirm that the misleading explanation is corrected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100