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

hub: document getExternalRepo arguments

Browse source 
Describe the types of each argument to the get_external_repo() method.
This commit is contained in:
Ken Dreyer 2020-04-03 15:03:21 -06:00 • committed by Tomas Kopecek
parent ffe41f267a
commit 9247422258
1 changed files with 13 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

18
hub/kojihub.py
View file

@ -3592,11 +3592,19 @@ def get_external_repos(info=None, url=None, event=None, queryOpts=None):
def get_external_repo(info, strict=False, event=None):
"""Get information about a single external repo.
info can either be a string (name) or an integer (id).
Returns a map containing the id, name, and url of the
repo. If strict is True and no external repo has the
given name or id, raise an error."""
"""
Get information about a single external repository.
:param info: a string (name) or an integer (id).
:param bool strict: If True, raise an error if we found no matching
repository. If False, simply return None if we found
no matching repository. If unspecified, the default
value is False.
:param int event: The event ID at which to search. If unspecified, the
default behavior is to search for the "active" repo
settings.
:returns: a map containing the id, name, and url of the repository.
"""
repos = get_external_repos(info, event=event)
if repos:
return repos[0]