twisted.python.usage.Options documentation is incomplete.
Open
Nobody has claimed this yet.
core
documentation
enhancement
new
priority-normal
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
@tomprince reported |
|---|---|
| Trac ID | trac#6319 |
| Type | enhancement |
| Created | 2013-02-21 20:41:42Z |
- The docstring isn't parse properly, thus the examples are improperly formatted.
synopsisandlongdescclass variables aren't documented.getUsageand__str__aren't documented
Searchable metadata
trac-id__6319 6319
type__enhancement enhancement
reporter__tom_prince tom.prince
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__core core
keywords__documentation documentation
time__1361479302000000 1361479302000000
changetime__1361479302000000 1361479302000000
version__None None
owner__
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
Review the Options documentation in twisted.python.usage, starting with its docstring and the entries for synopsis, longdesc, getUsage, and str. Check that the examples parse correctly and that each listed class variable and method is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100