Commit graph

190 commits

Author SHA1 Message Date
Victor Stinner
980dd84f92 asyncio doc: more explicit doc for async()
The function schedules the execution of coroutines, it's not just a wrapper for
something.
2014-10-12 21:36:17 +02:00
Victor Stinner
6888b96cee asyncio doc: cleanup Hello World examples 2014-10-11 16:15:58 +02:00
Berker Peksag
9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag
3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
R David Murray
22dd8334cd Improve English phrasing in asyncio task docs. 2014-09-24 11:09:09 -04:00
Victor Stinner
337e03ff78 Issue #22112, asyncio doc: replace loop.create_task(coro) with
asyncio.async(coro), mention that asyncio.async() can be used to scheduler a
coroutine, and make it clear that create_task() is only available in Python
3.4.2 and later.
2014-08-11 01:11:13 +02:00
Terry Jan Reedy
c935a9530c Englich grammar nit. 2014-07-24 02:33:14 -04:00
Victor Stinner
530ef2f069 Update asyncio documentation
- Document the new create_task() method
- "Hide" the Task class: point to the create_task() method for interoperability
- Rewrite the documentation of the Task class
- Document the "Pending task destroyed"
- Update output in debug mode of examples in the dev section
- Replace Task() with create_task() in examples
2014-07-08 12:39:10 +02:00
Victor Stinner
63b21a8ffa Closes #21921: Fix ResourceWarning in the asyncio examples: close the event
loop at exit. Patch written by Vajrasky Kok (I modified also the "hello world"
example using a coroutine).
2014-07-05 15:38:59 +02:00
Victor Stinner
db74d982d4 Issue #21596: asyncio.wait(): mention that the sequence of futures must not
be empty.
2014-06-10 11:16:05 +02:00
Victor Stinner
8d21357fb5 Issue #21601: Document asyncio.Task.cancel(). Initial patch written by Vajrasky
Kok.
2014-06-02 23:06:46 +02:00
Victor Stinner
28d0ae48e9 Issue #21376: document asyncio.TimeoutError 2014-05-29 00:04:57 +02:00
Yury Selivanov
37f15bcfed asyncio.docs: Improve wordings; add a note to the Coroutines section. Issue #20706 2014-02-20 16:20:44 -05:00
Victor Stinner
04e05da1b3 Close #20652: asyncio doc: close the event loop in run_forever() example. Fix
also typo. Patch written by Vajrasky Kok.
2014-02-17 10:54:30 +01:00
Brian Curtin
c9d1a6b85e merge 2014-02-08 18:36:57 -06:00
Brian Curtin
a1afeec9aa Spelling corrections. Submitted to python-dev by python@mrabarnett.plus.com 2014-02-08 18:36:14 -06:00
Victor Stinner
12c68b20b7 asyncio doc: fix gather() doc 2014-02-09 01:35:24 +01:00
Victor Stinner
45b27ed53d asyncio doc: document the granularity of the event loop
Improve also the "Logging" section
2014-02-01 02:36:43 +01:00
Victor Stinner
1ad5afc050 asyncio: document iscoroutine(), iscoroutinefunction() and wait_for()
Mention that wait_for() now accepts None for the timeout.
2014-01-30 00:18:50 +01:00
Victor Stinner
f40c66334d asyncio doc: close the loop at exit 2014-01-28 23:32:40 +01:00
Eli Bendersky
029981bbfc Clarify what the loop arguments means for functions listed in 18.5.2.5 2014-01-20 07:02:22 -08:00
Eli Bendersky
2d26af82c1 Explain the 'result' argument in asyncio.sleep 2014-01-20 06:59:23 -08:00
Victor Stinner
59759ff234 asyncio doc: replace "coroutine" with "coroutine object" or "coroutine function" 2014-01-16 19:30:21 +01:00
Victor Stinner
db39a0da0c asyncio: add a new "Develop with asyncio" section to the documentation 2014-01-16 18:58:01 +01:00
R David Murray
6a14381530 Fix Sphinx markup for asyncio modules so :mod:asyncio links work. 2013-12-20 14:37:39 -05:00
Victor Stinner
86e139ad65 asyncio doc: explain where does the task come from. 2013-12-13 12:51:24 +01:00
Victor Stinner
1c4b892d71 Add a sequence diagram for the chained coroutines example 2013-12-12 12:35:17 +01:00
Victor Stinner
a6fa15367f asyncio doc: simplify task example 2013-12-10 12:20:14 +01:00
Victor Stinner
0839ed4730 asyncio doc: don't document Task.cancel(), already documented in Future.cancel() 2013-12-10 12:18:15 +01:00
Victor Stinner
742520be43 asyncio: document Task.current_task() 2013-12-10 12:14:50 +01:00
Victor Stinner
fc25d629ab asyncio: don't document private functions 2013-12-10 02:52:49 +01:00
Victor Stinner
34f2946a11 asyncio: fix 2nd task example 2013-12-10 02:51:05 +01:00
Victor Stinner
b69d62dcac assyncio doc: rewrite, improve and move coroutine, Future and Task examples 2013-12-10 02:09:46 +01:00
Victor Stinner
d8f11e9265 asyncio: another Future example using add_done_callback() 2013-12-09 13:04:12 +01:00
Victor Stinner
45c2fd9f8a asyncio doc: add an example with Future 2013-12-09 12:40:17 +01:00
Victor Stinner
99c2ab4b83 asyncio doc: oh, asyncio module has its own Future class
Improve also wait() documentation: mention that the first parameter is a
sequence
2013-12-03 19:17:25 +01:00
Victor Stinner
c6fba92ebc asyncio doc: add one more example of coroutines 2013-12-03 17:37:31 +01:00
Victor Stinner
933a8c82ce asyncio doc: reorder methods; typo 2013-12-03 01:59:38 +01:00
Victor Stinner
3e09e32c8a asyncio doc: move coroutine example to the Task page 2013-12-03 01:22:06 +01:00
Victor Stinner
ea3183f5b8 Split asyncio documentation into subfiles 2013-12-03 01:08:00 +01:00