diff options
| author | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-23 21:23:38 (GMT) |
|---|---|---|
| committer | Serhiy Storchaka <storchaka@gmail.com> | 2013-08-23 21:23:38 (GMT) |
| commit | 9e0ae5398097e56490bcc720fe7ca56d50aec175 (patch) | |
| tree | aa3316a3e4c42c77d968d70962c9b4b449ec5821 /Doc/library/subprocess.rst | |
| parent | 78ede7c96d016eb0149c876bcb32633e3182e904 (diff) | |
| download | cpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.zip cpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.tar.gz cpython-9e0ae5398097e56490bcc720fe7ca56d50aec175.tar.bz2 | |
Issue #18757: Improved cross-references in the concurrent package.
Diffstat (limited to 'Doc/library/subprocess.rst')
| -rw-r--r-- | Doc/library/subprocess.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index 3a30821..f115634 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -76,7 +76,7 @@ use cases, the underlying :class:`Popen` interface can be used directly. Run command with arguments. Wait for command to complete. If the return code was zero then return, otherwise raise :exc:`CalledProcessError`. The :exc:`CalledProcessError` object will have the return code in the - :attr:`returncode` attribute. + :attr:`~CalledProcessError.returncode` attribute. The arguments shown above are merely the most common ones, described below in :ref:`frequently-used-arguments` (hence the use of keyword-only notation @@ -122,8 +122,8 @@ use cases, the underlying :class:`Popen` interface can be used directly. If the return code was non-zero it raises a :exc:`CalledProcessError`. The :exc:`CalledProcessError` object will have the return code in the - :attr:`returncode` attribute and any output in the :attr:`output` - attribute. + :attr:`~CalledProcessError.returncode` attribute and any output in the + :attr:`~CalledProcessError.output` attribute. The arguments shown above are merely the most common ones, described below in :ref:`frequently-used-arguments` (hence the use of keyword-only notation @@ -607,14 +607,14 @@ Instances of the :class:`Popen` class have the following methods: .. method:: Popen.poll() - Check if child process has terminated. Set and return :attr:`returncode` - attribute. + Check if child process has terminated. Set and return + :attr:`~Popen.returncode` attribute. .. method:: Popen.wait(timeout=None) - Wait for child process to terminate. Set and return :attr:`returncode` - attribute. + Wait for child process to terminate. Set and return + :attr:`~Popen.returncode` attribute. If the process does not terminate after *timeout* seconds, raise a :exc:`TimeoutExpired` exception. It is safe to catch this exception and @@ -860,8 +860,8 @@ In this section, "a becomes b" means that b can be used as a replacement for a. In addition, the replacements using :func:`check_output` will fail with a :exc:`CalledProcessError` if the requested operation produces a non-zero - return code. The output is still available as the ``output`` attribute of - the raised exception. + return code. The output is still available as the + :attr:`~CalledProcessError.output` attribute of the raised exception. In the following examples, we assume that the relevant functions have already been imported from the :mod:`subprocess` module. |