io.BufferedRWPair doc warning may need clarification
Open
Nobody has claimed this yet.
3.7 (EOL)
docs
topic-IO
type-bug
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 38595 |
|---|---|
| Nosy | @pitrou, @benjaminp |
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-10-26.05:19:33.715>
labels = ['type-bug', '3.7', 'docs']
title = 'io.BufferedRWPair doc warning may need clarification'
updated_at = <Date 2019-10-26.05:30:22.117>
user = 'https://bugs.python.org/rgov'
bugs.python.org fields:
activity = <Date 2019-10-26.05:30:22.117>
actor = 'rgov'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-26.05:19:33.715>
creator = 'rgov'
dependencies = []
files = []
hgrepos = []
issue_num = 38595
keywords = []
message_count = 2.0
messages = ['355404', '355405']
nosy_count = 5.0
nosy_names = ['pitrou', 'benjamin.peterson', 'stutzbach', 'docs@python', 'rgov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38595'
versions = ['Python 3.7']
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 the io.BufferedRWPair documentation and the migrated BPO issue 38595, including its two comments. Locate the warning referenced by the issue and determine what clarification is needed; the work is done when the relevant documentation clearly explains that warning.
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
- Needs clarification
- Newbie friendliness
- 28/100