diff options
| author | Brian Rosmaita <rosmaita.fossdev@gmail.com> | 2017-08-30 07:02:16 -0400 |
|---|---|---|
| committer | Brian Rosmaita <rosmaita.fossdev@gmail.com> | 2017-08-30 07:05:34 -0400 |
| commit | a7d35ccd812a48dcb7f84bba618da3b1a291beac (patch) | |
| tree | cc6a13d8aae8a629958e25e993690f8d748f0769 | |
| parent | aeaee20c8db756e66f59285520a4e5cacdb740f2 (diff) | |
| download | oslo-concurrency-a7d35ccd812a48dcb7f84bba618da3b1a291beac.tar.gz | |
Minor correction to docstrings3.22.0
Noticed that the generated docs were displaying the parameter
to trycmd() in a misleading way, fixed the syntax there and for
get_worker_count().
Change-Id: If989523be81e917ed62f525f2431f368dcf13c7a
| -rw-r--r-- | oslo_concurrency/processutils.py | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/oslo_concurrency/processutils.py b/oslo_concurrency/processutils.py index 2900918..744c849 100644 --- a/oslo_concurrency/processutils.py +++ b/oslo_concurrency/processutils.py @@ -474,8 +474,10 @@ def trycmd(*args, **kwargs): the command's stdout and stderr. If 'err' is not empty then the command can be considered to have failed. - :discard_warnings True | False. Defaults to False. If set to True, - then for succeeding commands, stderr is cleared + :param discard_warnings: True | False. Defaults to False. If set to True, + then for succeeding commands, stderr is cleared + :type discard_warnings: boolean + :returns: (out, err) from process execution """ discard_warnings = kwargs.pop('discard_warnings', False) @@ -563,8 +565,8 @@ def ssh_execute(ssh, cmd, process_input=None, def get_worker_count(): """Utility to get the default worker count. - @return: The number of CPUs if that can be determined, else a default - worker count of 1 is returned. + :returns: The number of CPUs if that can be determined, else a default + worker count of 1 is returned. """ try: return multiprocessing.cpu_count() |