add docstring for ansible.inventory.helpers.get_group_vars

Document the expected parameter type and return type of
get_group_vars().
This commit is contained in:
Ken Dreyer 2018-09-14 12:04:52 -06:00 committed by Brian Coca
parent 5adcaf4538
commit e46ce1619f

View file

@ -27,7 +27,12 @@ def sort_groups(groups):
def get_group_vars(groups):
"""
Combine all the group vars from a list of inventory groups.
:param groups: list of ansible.inventory.group.Group objects
:rtype: dict
"""
results = {}
for group in sort_groups(groups):
results = combine_vars(results, group.get_vars())