Commit message (Collapse) | Author | Age | Files | Lines | |
---|---|---|---|---|---|
* | bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) | Martin Fischer | 2022-05-19 | 1 | -0/+4 |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | API members documented in sphinx have an object name, which allow the documentation to be linked from other projects. Sphinx calculates the object name by prefixing the current module name to the directive argument, e.g: .. module:: foo .. function:: bar.baz becomes foo.bar.baz. Since these anchors aren't displayed in the documentation, some mistakes have crept in, namely the Python stdlib documentation currently contains the objects: * asyncio.asyncio.subprocess.DEVNULL * asyncio.asyncio.subprocess.PIPE * asyncio.asyncio.subprocess.STDOUT * asyncio.asyncio.subprocess.Process * multiprocessing.sharedctypes.multiprocessing.Manager * xml.etree.ElementTree.xml.etree.ElementInclude This commit fixes this by making use of the :module: option which without an argument makes sphinx take the directive argument as is for the object name (avoiding the prefixing of the current module name that led to these broken object names). Co-authored-by: Łukasz Langa <lukasz@langa.pl> | ||||
* | asyncio.subprocess: Fix a typo in doc (#92030) | Harsh | 2022-05-02 | 1 | -1/+1 |
| | | | Remove a confusion for read method in asyncio-subprocess doc for stderr StreamReader instance | ||||
* | bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) | Serhiy Storchaka | 2022-02-18 | 1 | -12/+4 |
| | |||||
* | bpo-42392: [docs] Add deprecated-removed loop labels for asyncio (GH-26357) | Ken Jin | 2021-05-26 | 1 | -0/+14 |
| | | | | * Add deprecated-removed loop labels for all reelvant functions/classes in asyncio | ||||
* | Update asyncio-subprocess.rst (GH-21680) | Gabriel R F | 2021-04-26 | 1 | -1/+1 |
| | |||||
* | [doc] Fix erroneous backslashes in signatures and names (GH-23658) | Andre Delfino | 2020-12-17 | 1 | -3/+3 |
| | | | | | The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch). The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did. | ||||
* | bpo-42392: Remove deprecated loop parameter from docs (GH-23552) | Yurii Karabas | 2020-11-29 | 1 | -11/+2 |
| | |||||
* | bpo-41217: Fix incorrect note in the asyncio.create_subprocess_shell() docs ↵ | Zackery Spytz | 2020-10-19 | 1 | -4/+2 |
| | | | | | (GH-21360) On Windows, the default asyncio event loop is ProactorEventLoop (as of 3.8). | ||||
* | closes bpo-40774: Fix docs indentation for asyncio.create_subprocess_shell() ↵ | sth | 2020-05-26 | 1 | -8/+8 |
| | | | | (GH-20403) | ||||
* | docs: Add asyncio source code links (GH-16640) | Kyle Stanley | 2019-10-10 | 1 | -0/+5 |
| | |||||
* | bpo-36373: Deprecate explicit loop in task and subprocess API (GH-16033) | Andrew Svetlov | 2019-09-12 | 1 | -0/+8 |
| | |||||
* | bpo-35621: Support running subprocesses in asyncio when loop is executed in ↵ | Andrew Svetlov | 2019-06-30 | 1 | -9/+17 |
| | | | | non-main thread (GH-14344) | ||||
* | Fix doc for create_subprocess_exec (GH-12598) | Dima Tisnek | 2019-04-05 | 1 | -1/+1 |
| | | | Add missing `program` argument to asyncio.create_subprocess_exec documentation. | ||||
* | bpo-34687: Update asyncio doc for ProactorEventLoop (GH-9623) | Victor Stinner | 2018-09-28 | 1 | -4/+0 |
| | | | | | | | | | | Since ProactorEventLoop is now the default in 3.8, remove examples using it explicitly on Windows. https://bugs.python.org/issue34687 | ||||
* | bpo-33649: A copy-editing pass on asyncio documentation (GH-9376) | Elvis Pranskevichus | 2018-09-17 | 1 | -28/+29 |
| | |||||
* | bpo-33649: Add low-level APIs index. (GH-9364) | Yury Selivanov | 2018-09-17 | 1 | -1/+3 |
| | |||||
* | bpo-33649: Add high-level APIs cheat-sheet (GH-9319) | Yury Selivanov | 2018-09-14 | 1 | -0/+2 |
| | |||||
* | bpo-33649: Polish asyncio subprocess and sync docs (GH-9285) | Carol Willing | 2018-09-14 | 1 | -9/+8 |
| | | | | | | Second pass for asyncio subprocess and sync docs. https://bugs.python.org/issue33649 | ||||
* | bpo-33649: First asyncio docs improvement pass (GH-9142) | Yury Selivanov | 2018-09-11 | 1 | -269/+202 |
| | | | | | | | | | | | | | Rewritten/updated sections: * Event Loop APIs * Transports & Protocols * Streams * Exceptions * Policies * Queues * Subprocesses * Platforms | ||||
* | bpo-34335: Use async/await syntax in documentation examples (GH-8674) | Mikhail Terekhov | 2018-08-07 | 1 | -2/+1 |
| | |||||
* | bpo-32258: Replace 'yield from' to 'await' in asyncio docs (#4779) | Andrew Svetlov | 2017-12-11 | 1 | -12/+11 |
| | | | | | | * Replace 'yield from' to 'await' in asyncio docs * Fix docstrings | ||||
* | Add the link to asyncio source code in the docs (GH-2373) | lf | 2017-07-25 | 1 | -0/+2 |
| | |||||
* | Correct spelling "instanciate" (#465) | J. W | 2017-03-04 | 1 | -2/+2 |
| | |||||
* | Issue #27700: Document AbstractEventLoop, not BaseEventLoop. | Guido van Rossum | 2016-08-08 | 1 | -13/+13 |
| | |||||
* | Closes #25910: fix dead and permanently redirected links in the docs. Thanks ↵ | Georg Brandl | 2016-02-26 | 1 | -2/+2 |
| | | | | to SilentGhost for the patch. | ||||
* | Use sys.platform instead of os.name to detect Windows in asyncio docs. Patch ↵ | Guido van Rossum | 2015-11-02 | 1 | -2/+2 |
| | | | | by Akira Li. | ||||
* | asyncio doc: fix subprocess sections | Victor Stinner | 2015-09-02 | 1 | -4/+4 |
| | |||||
* | Make sentence correct English. | R David Murray | 2015-05-14 | 1 | -1/+1 |
| | |||||
* | asyncio: add a note about (non) thread safety in each class | Victor Stinner | 2015-02-25 | 1 | -0/+5 |
| | |||||
* | asyncio doc: annotate coroutine on coroutine functions and methods | Victor Stinner | 2015-02-12 | 1 | -6/+6 |
| | |||||
* | asyncio doc: list limitations to run subprocesses from different threads | Victor Stinner | 2015-01-09 | 1 | -0/+19 |
| | |||||
* | asyncio doc: rewrite subprocess doc | Victor Stinner | 2014-10-13 | 1 | -77/+179 |
| | | | | | | | | | | | | | | | * add a new example using transport and protocol * rewrite the example using streams to make it much simpler (remove error handling, use a simpler Python code) * copy (and adapt) more documentation from the subprocess module: - add a note about Process.wait() deadlock - add a note about shell injection - etc. * sort Process methods and attributes in the same order than subprocess.Popen methods and attributes, so the documentation looks closer * list differences between Process and subprocess.Popen APIs | ||||
* | asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must | Victor Stinner | 2014-10-13 | 1 | -0/+6 |
| | | | | instanciate a subclass of SubprocessProtocol | ||||
* | asyncio, tulip issue 190: Process.communicate() now ignores | Victor Stinner | 2014-07-17 | 1 | -4/+5 |
| | | | | ConnectionResetError too | ||||
* | asyncio, tulip issue 190: Process.communicate() must ignore BrokenPipeError | Victor Stinner | 2014-07-17 | 1 | -0/+7 |
| | | | | | | | | If you want to handle the BrokenPipeError, you can easily reimplement communicate(). Add also a unit test to ensure that stdin.write() + stdin.drain() raises BrokenPipeError. | ||||
* | asyncio: enhance documentation of platform support | Victor Stinner | 2014-07-11 | 1 | -0/+7 |
| | |||||
* | Issue #21680: Document asyncio event loops | Victor Stinner | 2014-07-08 | 1 | -12/+12 |
| | |||||
* | Closes #21758: asyncio doc: mention explicitly that subprocess parameters are | Victor Stinner | 2014-06-19 | 1 | -6/+10 |
| | | | | bytes or character strings | ||||
* | Issue #21485: remove unnecesary .flush() calls in the asyncio subprocess code | Victor Stinner | 2014-05-12 | 1 | -3/+1 |
| | | | | example | ||||
* | asyncio docs: ProactorEventLoop does not support SSL. | Guido van Rossum | 2014-05-05 | 1 | -1/+1 |
| | |||||
* | Issue #21006: asyncio doc: reorganize subprocess doc | Victor Stinner | 2014-03-25 | 1 | -4/+90 |
| | |||||
* | Issue #21006: Fix subprocess example on Windows in asyncio doc | Victor Stinner | 2014-03-21 | 1 | -1/+6 |
| | |||||
* | Close #21005: Fix documentation of asyncio.subprocess.DEVNULL | Victor Stinner | 2014-03-21 | 1 | -4/+3 |
| | |||||
* | Issue #20950: Fix typo asyncio doc, wait() has no self parameter | Victor Stinner | 2014-03-16 | 1 | -1/+5 |
| | | | | | self parameter is implicit. Mention also that communicate() and wait() are coroutines. | ||||
* | asyncio doc: functions are coroutine, they don't return a coroutine | Victor Stinner | 2014-03-13 | 1 | -2/+2 |
| | | | | It's not exact, but easier to understand. | ||||
* | asyncio doc: fix references in subprocess doc | Victor Stinner | 2014-02-24 | 1 | -2/+2 |
| | |||||
* | asyncio: Remove Process.subprocess attribute; it's too easy to get inconsistent | Victor Stinner | 2014-02-09 | 1 | -5/+1 |
| | | | | Process and Popen objects | ||||
* | Spelling corrections. Submitted to python-dev by python@mrabarnett.plus.com | Brian Curtin | 2014-02-09 | 1 | -3/+3 |
| | |||||
* | asyncio doc: add an example of asyncio.subprocess with communicate() and wait() | Victor Stinner | 2014-02-03 | 1 | -0/+40 |
| | |||||
* | asyncio.subprocess: Replace Process.get_subprocess() method with a | Victor Stinner | 2014-02-03 | 1 | -17/+17 |
| | | | | Process.subprocess read-only property |