Possibly misleading/wrong documentation about PyModuleDef.m_free
Open
Nobody has claimed this yet.
3.7 (EOL)
3.8 (EOL)
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 34478 |
|---|---|
| Nosy | @segevfiner |
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 2018-08-23.15:07:34.636>
labels = ['3.8', 'type-feature', '3.7', 'docs']
title = 'Possibly misleading/wrong documentation about PyModuleDef.m_free'
updated_at = <Date 2018-08-23.15:07:34.636>
user = 'https://github.com/segevfiner'
bugs.python.org fields:
activity = <Date 2018-08-23.15:07:34.636>
actor = 'Segev Finer'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-08-23.15:07:34.636>
creator = 'Segev Finer'
dependencies = []
files = []
hgrepos = []
issue_num = 34478
keywords = []
message_count = 1.0
messages = ['323955']
nosy_count = 2.0
nosy_names = ['docs@python', 'Segev Finer']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue34478'
versions = ['Python 3.7', 'Python 3.8']
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
Start by locating the Python documentation that describes PyModuleDef.m_free and compare its wording with the behavior or API definition. Determine the precise misleading statement before changing it, then verify that the revised documentation accurately explains m_free and its usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100