twisted / twisted/twisted

Deferred howto should demonstrate loops involving asynchronous functions

Open
#6,387 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core deferred documentation enhancement howto new priority-normal
Dominant language
Python
Stars
6k
Forks
1.2k
Avg merge
2d 10h
Merged PRs (30d)
10

Description

jonathanj's avatar @jonathanj reported
Trac ID trac#6387
Type enhancement
Created 2013-03-22 17:39:30Z

In my experience, new users often have a hard time conceptualising how to work with asynchronous functions when performing loops.

The new Deferred howto draws parallels between a number of synchronous constructs, such as try/except, and their asynchronous counterparts, but despite having an example of a synchronous loop it does not go into detail about similar things involving asynchronous functions. I feel that some prose on the topics of, but not limited to, gathering results or serialising async tasks would benefit newcomers.

Searchable metadata
trac-id__6387 6387
type__enhancement enhancement
reporter__jonathanj jonathanj
priority__normal normal
milestone__ 
branch__ 
branch_author__ 
status__new new
resolution__None None
component__core core
keywords__deferred_howto_documentation deferred howto documentation
time__1363973970000000 1363973970000000
changetime__1363973970000000 1363973970000000
version__None None
owner__ 

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing Deferred howto and its synchronous loop example. Add newcomer-focused prose and examples covering asynchronous loops, including gathering results and serialising async tasks. Done means the howto clearly explains these loop patterns alongside its existing synchronous comparisons.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.