Documentation update: deferred results in PB
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
 |
daniel reported |
|---|---|
| Trac ID | trac#2555 |
| Type | enhancement |
| Created | 2007-04-07 18:17:53Z |
| Branch | https://github.com/twisted/twisted/tree/deferred-pb-2555 |
It is not readily apparent in the documentation that PB remote_xxx() methods can return deferred results. The documentation should be updated with an explanation and an example. I volunteer to provide a patch.
Attachments:
- pb_deferred_results.patch (1915 bytes) - added by daniel on 2007-04-07 18:18:36Z - Patch for PB usage docs
Searchable metadata
trac-id__2555 2555
type__enhancement enhancement
reporter__daniel daniel
priority__normal normal
milestone__
branch__branches_deferred_pb_2555 branches/deferred-pb-2555
branch_author__
status__new new
resolution__None None
component__core core
keywords__documentation documentation
time__1175969873000000 1175969873000000
changetime__1295965626000000 1295965626000000
version__None None
owner__
cc__thijs
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 the attached pb_deferred_results.patch and the deferred-pb-2555 branch to locate the PB usage documentation it changes. Confirm the documentation explains that remote_xxx() methods can return deferred results and includes an example; the update is done when that explanation and example are present in the relevant PB docs.
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
- 25/100