hub: document setInheritanceData arguments

Describe each of the arguments to the setInheritanceData() method.
This commit is contained in:
Ken Dreyer 2019-02-28 15:57:05 -07:00 committed by Mike McLean
parent 92c111ee9b
commit 365d4e2448

View file

@ -10052,6 +10052,22 @@ class RootExports(object):
return readInheritanceData(tag, event)
def setInheritanceData(self, tag, data, clear=False):
"""
Set inheritance relationships for a tag.
This tag will be the "child" that inherits from a list of "parents".
:param tag: The koji tag that will inherit from parent tags.
:type tag: int or str
:param list data: Inheritance rules to set for this child tag. This is
a list of rules (dicts) for parent tags and
priorities. If any rule dict in the list has a
special "remove link": True key and value, Koji will
remove this inheritance rule instead of adding it.
:param bool clear: Wipe out all existing inheritance rules and only
apply the ones you submit here. If unspecified,
this defaults to False.
"""
if not isinstance(tag, six.integer_types):
#lookup tag id
tag = get_tag_id(tag, strict=True)