return value of builtins is not clearly indicated
Open
Nobody has claimed this yet.
3.11
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 46282 |
|---|---|
| Nosy | @warsaw, @terryjreedy, @nedbat, @merwok, @stevendaprano, @iritkatriel, @snoopjedi |
| PRs |
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 2022-01-06.14:52:27.230>
labels = ['3.11', 'docs']
title = 'return value of builtins is not clearly indicated'
updated_at = <Date 2022-02-12.01:20:07.186>
user = 'https://github.com/SnoopJeDi'
bugs.python.org fields:
activity = <Date 2022-02-12.01:20:07.186>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2022-01-06.14:52:27.230>
creator = 'SnoopJeDi'
dependencies = []
files = []
hgrepos = []
issue_num = 46282
keywords = ['patch']
message_count = 17.0
messages = ['409857', '409870', '409874', '409883', '409886', '410038', '410046', '411632', '411653', '411664', '411668', '411809', '411835', '412797', '412811', '412836', '412838']
nosy_count = 8.0
nosy_names = ['barry', 'terry.reedy', 'nedbat', 'eric.araujo', 'steven.daprano', 'docs@python', 'iritkatriel', 'SnoopJeDi']
pr_nums = ['30435']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue46282'
versions = ['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 reviewing BPO issue 46282 and the discussion associated with PR #30435, since the issue is already marked for patch review. Determine which builtin documentation passages are covered by that work and confirm that their return values are clearly indicated when the documentation changes are complete.
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
- 15/100