Give all of Twisted Pair's modules docstrings
Open
Nobody has claimed this yet.
enhancement
new
pair
priority-normal
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
@exarkun reported |
|---|---|
| Trac ID | trac#6996 |
| Type | enhancement |
| Created | 2014-02-27 12:59:04Z |
All modules should have docstrings.
Searchable metadata
trac-id__6996 6996
type__enhancement enhancement
reporter__exarkun exarkun
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__pair pair
keywords__
time__1393505944000000 1393505944000000
changetime__1393505944000000 1393505944000000
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
No files, tests, or entry points are named. Begin by locating the Twisted Pair component's modules in the repository and checking which lack docstrings. The work is done when all of Twisted Pair's modules have docstrings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100