particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

cli: document parse_arches method parameters

Browse source 
Document the parameters for the parse_arches method.
This commit is contained in:
Ken Dreyer 2018-11-29 08:20:38 -07:00
parent 0e043e1e6b
commit 9fe61b561f
1 changed files with 12 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

14
cli/koji_cli/lib.py
View file

@ -141,8 +141,18 @@ def print_task_recurse(task,depth=0):
def parse_arches(arches, to_list=False):
"""Parse comma or space-separated list of arches and return
only space-separated one."""
"""Normalize user input for a list of arches.
This method parses a single comma- or space-separated string of arches and
returns a space-separated string.
:param str arches: comma- or space-separated string of arches, eg.
"x86_64,ppc64le", or "x86_64 ppc64le"
:param bool to_list: return a list of each arch, instead of a single
string. This is False by default.
:returns: a space-separated string like "x86_64 ppc64le", or a list like
['x86_64', 'ppc64le'].
"""
arches = arches.replace(',', ' ').split()
if to_list:
return arches