Make documentation of * in function signatures easier to find
Open
Nobody has claimed this yet.
3.10
3.8 (EOL)
3.9 (EOL)
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 42571 |
|---|---|
| Nosy | @merwok, @fredg1 |
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-12-04.21:11:08.529>
labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
title = 'Make documentation of * in function signatures easier to find'
updated_at = <Date 2020-12-14.14:34:02.476>
user = 'https://github.com/fredg1'
bugs.python.org fields:
activity = <Date 2020-12-14.14:34:02.476>
actor = 'eric.araujo'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-12-04.21:11:08.529>
creator = 'fredg1'
dependencies = []
files = []
hgrepos = []
issue_num = 42571
keywords = []
message_count = 5.0
messages = ['382530', '382876', '382965', '382966', '382989']
nosy_count = 3.0
nosy_names = ['eric.araujo', 'docs@python', 'fredg1']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue42571'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']
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
No documentation file or test is named in the issue. Start by locating the CPython documentation for function signatures and the existing explanation of *; done means that readers can find and understand how * is documented in signatures.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100