Centralized documentation of assumptions made by C code
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 558
Description
| BPO | 33050 |
|---|---|
| Nosy | @benjaminp, @tvanslyke |
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-03-11.18:17:26.481>
labels = ['docs']
title = 'Centralized documentation of assumptions made by C code'
updated_at = <Date 2018-03-12.06:29:39.491>
user = 'https://github.com/tvanslyke'
bugs.python.org fields:
activity = <Date 2018-03-12.06:29:39.491>
actor = 'benjamin.peterson'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2018-03-11.18:17:26.481>
creator = 'tvanslyke'
dependencies = []
files = []
hgrepos = []
issue_num = 33050
keywords = []
message_count = 2.0
messages = ['313607', '313634']
nosy_count = 3.0
nosy_names = ['benjamin.peterson', 'docs@python', 'tvanslyke']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue33050'
versions = ['Python 3.6']
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 linked BPO issue 33050 and the migrated discussion, since the payload names no files, tests, or entry points. The issue does not define which C assumptions to document or what completion should look like, so its scope and acceptance criteria need clarification before work can begin.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100