Capsule API usage docs are incompatible with module reloading (etc)
Open
Nobody has claimed this yet.
3.13
3.14
3.15
docs
type-bug
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 32459 |
|---|---|
| Nosy | @brettcannon, @ncoghlan, @encukou, @ericsnowcurrently, @Dormouse759 |
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 2017-12-31.05:27:01.669>
labels = ['type-bug']
title = 'Capsule API usage docs are incompatible with module reloading (etc)'
updated_at = <Date 2018-01-09.10:25:18.773>
user = 'https://github.com/ncoghlan'
bugs.python.org fields:
activity = <Date 2018-01-09.10:25:18.773>
actor = 'petr.viktorin'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = []
creation = <Date 2017-12-31.05:27:01.669>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 32459
keywords = []
message_count = 1.0
messages = ['309266']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'ncoghlan', 'petr.viktorin', 'eric.snow', 'Dormouse759']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue32459'
versions = []
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 reading the Capsule API usage documentation and examining how its examples behave when a module is reloaded. Identify the documented usage that becomes incompatible, then update the documentation so it remains valid with module reloading and verify the revised examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100