From be66e4cf70ad85df2b7aca47f5d3f9e950f1d3f3 Mon Sep 17 00:00:00 2001 From: iLLiCiTiT Date: Tue, 30 Mar 2021 19:37:23 +0200 Subject: [PATCH] added docstring to ApplicationGroup --- pype/lib/applications.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/pype/lib/applications.py b/pype/lib/applications.py index 3f573ba6c6..efe8d5f73e 100644 --- a/pype/lib/applications.py +++ b/pype/lib/applications.py @@ -91,6 +91,22 @@ class ApplicationLaunchFailed(Exception): class ApplicationGroup: + """Hold information about application group. + + Application group wraps different versions(variants) of application. + e.g. "maya" is group and "maya_2020" is variant. + + Group hold `host_name` which is implementation name used in pype. Also + holds `enabled` if whole app group is enabled or `icon` for application + icon path in resources. + + Group has also `environment` which hold same environments for all variants. + + Args: + name (str): Groups' name. + data (dict): Group defying data loaded from settings. + manager (ApplicationManager): Manager that created the group. + """ def __init__(self, name, data, manager): self.name = name self.manager = manager