Remove @see docstrings from IOCPReactor so that full API documentation can be inherited from the appropriate interface
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
 |
arbiter reported |
|---|---|
| Trac ID | trac#6483 |
| Type | enhancement |
| Created | 2013-04-27 12:53:30Z |
In twisted/internet/iocpreactor/reactor.py follows the same pattern as [#6459 ticket:6459].
Remove methods that contain only an @see reference will make the API document better.
Attachments:
- iocpreactor-apidocs-6483.patch (1768 bytes) - added by arbiter on 2013-04-27 13:20:37Z - a possible patch
- iocpreactor-apidocs-6483-2.patch (1770 bytes) - added by arbiter on 2013-04-28 04:03:11Z - add L{} docstring to some conditional methods that pydoctor doesn't handle.
Searchable metadata
trac-id__6483 6483
type__enhancement enhancement
reporter__arbiter arbiter
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__core core
keywords__documentation documentation
time__1367067210000000 1367067210000000
changetime__1367076915000000 1367076915000000
version__None None
owner__arbiter arbiter
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/internet/iocpreactor/reactor.py and compare its documentation pattern with ticket 6459. Review the attached iocpreactor-apidocs-6483 patches, including the conditional methods that need L{} docstrings for pydoctor. Done means removing @see-only methods so API documentation is inherited from the appropriate interface while preserving documentation pydoctor can process.
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
- Clearly specified
- Newbie friendliness
- 45/100