unittest assert helper methods have incorrect signature in docs
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 35676 |
|---|---|
| Nosy | @rbtcollins, @ezio-melotti, @voidspace, @tirkarthi |
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 2019-01-07.04:17:47.372>
labels = ['3.11', '3.9', '3.10', 'docs']
title = 'unittest assert helper methods have incorrect signature in docs'
updated_at = <Date 2021-04-25.16:15:40.381>
user = None
bugs.python.org fields:
activity = <Date 2021-04-25.16:15:40.381>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-01-07.04:17:47.372>
creator = '\xd7\x90\xd7\x95\xd7\xa8\xd7\x99'
dependencies = []
files = []
hgrepos = []
issue_num = 35676
keywords = []
message_count = 3.0
messages = ['333137', '333139', '333163']
nosy_count = 6.0
nosy_names = ['rbcollins', 'ezio.melotti', 'michael.foord', 'docs@python', 'xtreak', '\xd7\x90\xd7\x95\xd7\xa8\xd7\x99']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue35676'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
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 unittest documentation for the assert helper methods and compare the documented signatures with their actual APIs. Update the incorrect documentation and confirm the signatures are accurate in the rendered docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100