Add test documentation for docs tox target
Enable sphinx to generate documentation from docstrings by running
'tox -e docs'.
Change-Id: I5996e5f07493f69f14172b4bb0535852e89d5456
diff --git a/neutron_tempest_plugin/common/shell.py b/neutron_tempest_plugin/common/shell.py
index eebb07d..073bf55 100644
--- a/neutron_tempest_plugin/common/shell.py
+++ b/neutron_tempest_plugin/common/shell.py
@@ -47,18 +47,18 @@
:param timeout: command execution timeout in seconds
:param check: when False it doesn't raises ShellCommandFailed when
- exit status is not zero. True by default
+ exit status is not zero. True by default
:returns: STDOUT text when command execution terminates with zero exit
- status.
+ status.
:raises ShellTimeoutExpired: when timeout expires before command execution
- terminates. In such case it kills the process, then it eventually would
- try to read STDOUT and STDERR buffers (not fully implemented) before
- raising the exception.
+ terminates. In such case it kills the process, then it eventually would
+ try to read STDOUT and STDERR buffers (not fully implemented) before
+ raising the exception.
:raises ShellCommandFailed: when command execution terminates with non-zero
- exit status.
+ exit status.
"""
ssh_client = ssh_client or SSH_PROXY_CLIENT
if timeout: