b248a8c9a5
[3.7] bpo-11233: Create availability directive for documentation (GH-9692) (GH-9830)
...
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.
Co-Authored-By: Georg Brandl <georg@python.org>
(cherry picked from commit 2d6097d027
2018-10-15 22:52:26 +02:00
512d710109
bpo-33649: Backport asyncio docs from 'master' to 3.7 (GH-9377)
2018-09-17 19:35:30 -04:00
e02ca4270e
bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121)
...
The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`.
<!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613 ) -->
https://bugs.python.org/issue34613
<!-- /issue-number -->
(cherry picked from commit b4ec36200a
2018-09-11 11:59:29 -07:00
fac49762c5
bpo-34335: Use async/await syntax in documentation examples (GH-8674)
...
(cherry picked from commit d2ac400267
2018-08-07 13:33:31 -07:00
f4dcf49159
bpo-33736: Improve the documentation of asyncio stream APIs (GH-7326)
...
(cherry picked from commit c0d062f523
2018-06-08 08:54:31 -07:00
fe133aad52
bpo-32391: Implement StreamWriter.wait_closed() ( #5281 )
2018-01-25 00:30:30 +02:00
8874342cf3
bpo-32258: Replace 'yield from' to 'await' in asyncio docs ( #4779 )
...
* Replace 'yield from' to 'await' in asyncio docs
* Fix docstrings
2017-12-11 17:35:49 +02:00
ac577d7d0b
bpo-32154: Remove asyncio.windows_utils.socketpair ( #4609 )
2017-11-28 21:33:20 +01:00
627d2c8e8d
Add the link to asyncio source code in the docs (GH-2373)
2017-07-25 16:03:51 -07:00
e5b0bd1ba2
Fix default value of StreamReader.readuntil()
...
Reported by Sam Lunt on docs@p.o.
2016-10-18 00:34:46 +03:00
f68afd8544
Issue #27700 : Document AbstractEventLoop, not BaseEventLoop.
2016-08-08 09:41:21 -07:00
950204df9c
docs: Update asyncio docs & whatsnew
2016-05-16 16:23:00 -04:00
ded4c4967b
Trivial typo
2016-04-19 21:50:19 +02:00
f38c93fb7f
Issue #26368 : fix typo in asynchio stream doc, reported by Ryan Stuart.
2016-02-16 13:27:04 +11:00
cba0053bef
docs/asyncio: Twek sections names per Nick Coghlan suggestion
2015-12-16 21:30:52 -05:00
19ff6977a7
Issue #24885 : Update note in docs about stream convenience functions.
2015-10-19 13:18:04 -07:00
87d0066f1a
Fix English phrasing.
2015-09-27 12:36:19 -04:00
0424eaf753
Marked keystrokes with the :kbd: role.
...
Fixed the case of the "Ctrl-" prefixes.
2015-09-12 17:45:25 +03:00
d7e19bb566
docs/asyncio: Document new ensure_future() and deprecated async()
2015-05-11 16:33:41 -04:00
83704963c0
asyncio: add a note about (non) thread safety in each class
2015-02-25 14:24:15 +01:00
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
e7182979d6
Closes #22348 : Rephrase asyncio.StreamWriter.drain() documentation
...
Patch written by Martin Richard.
2014-11-28 17:45:41 +01:00
ed8e3a987e
asyncio: add missing @coroutine decorator
2014-10-13 00:55:50 +02:00
ed051594d7
asyncio doc: add TCP echo client/server using streams
2014-10-12 20:18:16 +02:00
ccd8e34508
asyncio doc: socket.socketpair() is not available on Windows yet
2014-10-11 16:30:02 +02:00
04e6df330d
asyncio doc: add examples showing the 3 ways to wait for data from an open
...
socket
2014-10-11 16:16:27 +02:00
5121a9ba4a
asyncio doc: the "Get HTTP headers" example now supports HTTPS
2014-10-11 15:52:14 +02:00
d71dcbb043
asyncio: update the doc
...
* dev: mention that the logging must be configured at DEBUG level
* streams: drain() has no more a strange return value, it's just
a standard coroutine
2014-08-25 17:04:12 +02:00
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
8ebeb03740
asyncio: improve the documentation of servers
...
- Fix the documentation of Server.close(): it closes sockets
- Replace AbstractServer with Server
- Document Server.sockets attribute
2014-07-11 23:47:40 +02:00
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
37f15bcfed
asyncio.docs: Improve wordings; add a note to the Coroutines section. Issue #20706
2014-02-20 16:20:44 -05:00
d3f8e30828
asyncio.docs: Improve documentation of Streams. Issue #20696 .
2014-02-20 14:10:02 -05:00
ffbe3c67df
asyncio doc: sort methods
2014-02-08 22:50:07 +01:00
084443809f
asyncio: document the new asyncio.subprocess module
2014-02-02 22:43:39 +01:00
9592edb834
asyncio doc: add "asyncio-" prefix to references
2014-02-02 15:03:02 +01:00
f40c66334d
asyncio doc: close the loop at exit
2014-01-28 23:32:40 +01:00
32970b8dec
asyncio: IncompleteReadError is a subclass of EOFError
2014-01-27 12:18:49 +01:00
b7f19ff94b
asyncio: document the IncompleteReadError exception
2014-01-27 11:58:49 +01:00
62f8eccdbf
asyncio doc: document StreamWriter.drain()
2014-01-24 18:47:26 +01:00
4b4f9ebfea
asyncio doc: add a "Coroutines and protocols" section
2014-01-24 17:33:20 +01:00
1374bd41b1
asyncio: mention that transports/protocols are low-level, streams are high-level
2014-01-24 15:34:19 +01:00
c520edc08b
asyncio doc: add an client example using streams
2014-01-23 11:25:48 +01:00
24f8ebf4c5
asyncio doc: Move streams to their own dedicated page
2014-01-23 11:05:01 +01:00
Cheryl Sabella
Yury Selivanov
Miss Islington (bot)
Andrew Svetlov
Victor Stinner
lf
Berker Peksag
Guido van Rossum
Yury Selivanov
Jesus Cea
Ned Deily
R David Murray
Serhiy Storchaka