Cmd.onecmd documentation is misleading
Open
Nobody has claimed this yet.
3.7 (EOL)
stdlib
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
| BPO | 32283 |
|---|
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 2017-12-12.00:20:54.862>
labels = ['3.7', 'library']
title = 'Cmd.onecmd documentation is misleading'
updated_at = <Date 2017-12-12.00:20:54.862>
user = 'https://bugs.python.org/lyda'
bugs.python.org fields:
activity = <Date 2017-12-12.00:20:54.862>
actor = 'lyda'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-12-12.00:20:54.862>
creator = 'lyda'
dependencies = []
files = []
hgrepos = []
issue_num = 32283
keywords = []
message_count = 1.0
messages = ['308082']
nosy_count = 1.0
nosy_names = ['lyda']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32283'
versions = ['Python 3.6', '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 locating the library documentation for Cmd.onecmd and compare its wording with the documented behavior. The issue does not identify a file or explain which text is misleading, so determine the needed clarification before editing; done means the documentation accurately describes Cmd.onecmd and the documentation checks pass.
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
- 25/100