openstack/oslo.concurrency
Code Issues Proposed changes

Minor correction to docstrings

Browse Source 
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
This commit is contained in:
Brian Rosmaita 2017-08-30 07:02:16 -04:00
parent aeaee20c8d
commit a7d35ccd81
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
oslo_concurrency/processutils.py
View File

@ -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()