conch docstrings have incorrect return values
Open
Nobody has claimed this yet.
bug
conch
documentation
new
priority-normal
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
 |
Alex reported |
|---|---|
| Trac ID | trac#6803 |
| Type | defect |
| Created | 2013-10-30 05:30:54Z |
| Branch | https://github.com/twisted/twisted/tree/conch-retval-docs-6803 |
This covers a series of errors in twisted.conch.ssh.keys
Attachments:
- t6803.diff (2999 bytes) - added by Alex on 2013-10-30 05:31:29Z -
- t6803.2.diff (3098 bytes) - added by Alex on 2013-10-30 16:15:23Z -
Searchable metadata
trac-id__6803 6803
type__defect defect
reporter__Alex Alex
priority__normal normal
milestone__
branch__branches_conch_retval_docs_6803 branches/conch-retval-docs-6803
branch_author__lvh lvh
status__new new
resolution__None None
component__conch conch
keywords__documentation documentation
time__1383111054000000 1383111054000000
changetime__1402442498000000 1402442498000000
version__None None
owner__lvh lvh
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 with twisted/conch/ssh/keys.py and review the affected docstrings, using the attached diffs to identify their intended scope. Done means the return-value documentation accurately matches the behavior of each affected method.
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
- Mostly clear
- Newbie friendliness
- 35/100