Add howto-style documentation for twisted.conch.client.knownhosts
Open
Nobody has claimed this yet.
conch
documentation
enhancement
new
priority-normal
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
@exarkun reported |
|---|---|
| Trac ID | trac#6340 |
| Type | enhancement |
| Created | 2013-02-28 23:48:09Z |
As basically everything should have this style of documentation (in addition to the other styles).
Searchable metadata
trac-id__6340 6340
type__enhancement enhancement
reporter__exarkun exarkun
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__conch conch
keywords__documentation documentation
time__1362095289000000 1362095289000000
changetime__1362095289000000 1362095289000000
version__None None
owner__
cc__z3p
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 twisted.conch.client.knownhosts and existing howto-style documentation in the Twisted repository. Add howto documentation for this module, alongside its other documentation styles, and verify that the resulting guide explains the module clearly.
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
- Mostly clear
- Newbie friendliness
- 45/100