From 2bf86369801a0d6e9d6041a35e839745517b1ccf Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Tue, 30 Apr 2024 14:19:23 +0300 Subject: [PATCH 1/6] update inline docs for applications and only_available --- server_addon/applications/server/settings.py | 21 ++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 5743e9f471..53b547ce13 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -144,7 +144,17 @@ class ToolGroupModel(BaseSettingsModel): class ApplicationsSettings(BaseSettingsModel): - """Applications settings""" + """Applications settings + + Define applications are available to your studio, locations of their + executables, and their additional environments. + + AYON uses the following definitions to populate the applications list + in project anatomy > attributes. + So, You'd still need modify your project anatomy settings. + + Use shortcut **a+a** to navigate to project anatomy. + """ maya: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Autodesk Maya") @@ -210,7 +220,14 @@ class ApplicationsAddonSettings(BaseSettingsModel): scope=["studio"] ) only_available: bool = SettingsField( - True, title="Show only available applications") + True, + title="Show only available applications", + description="Enable to show available applications in AYON Launcher" + " i.e. Show them if they are installed on the user" + " machine. Note: AYON Launcher shows only the selected" + " applications in project anatomy and this is another" + " filter to ignore uninstalled apps." + ) @validator("tool_groups") def validate_unique_name(cls, value): From 639d83755f3b5d37d58c1fbf04525020d4c49f71 Mon Sep 17 00:00:00 2001 From: Mustafa Taher Date: Tue, 30 Apr 2024 16:24:19 +0300 Subject: [PATCH 2/6] Update the description of `only_available` Co-authored-by: Roy Nieterau --- server_addon/applications/server/settings.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 53b547ce13..365f42789f 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -222,11 +222,10 @@ class ApplicationsAddonSettings(BaseSettingsModel): only_available: bool = SettingsField( True, title="Show only available applications", - description="Enable to show available applications in AYON Launcher" - " i.e. Show them if they are installed on the user" - " machine. Note: AYON Launcher shows only the selected" - " applications in project anatomy and this is another" - " filter to ignore uninstalled apps." + description="Enable to show only available applications in AYON Launcher" + " for which the executable paths are found on the running machine." + " This applies as an additional filter to the applications defined in a " + " project's anatomy settings to ignore unavailable applications." ) @validator("tool_groups") From 914448a2e779e251334af007b1ac591de0e7e4f8 Mon Sep 17 00:00:00 2001 From: Mustafa Taher Date: Tue, 30 Apr 2024 16:25:11 +0300 Subject: [PATCH 3/6] Remove shortcut from docstring Co-authored-by: Roy Nieterau --- server_addon/applications/server/settings.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 365f42789f..abfc2c67b7 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -152,8 +152,6 @@ class ApplicationsSettings(BaseSettingsModel): AYON uses the following definitions to populate the applications list in project anatomy > attributes. So, You'd still need modify your project anatomy settings. - - Use shortcut **a+a** to navigate to project anatomy. """ maya: AppGroupWithPython = SettingsField( From 5149802256f3f1d2b1dc07a87e87ca259ae90fda Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Tue, 30 Apr 2024 16:26:56 +0300 Subject: [PATCH 4/6] applications: update ApplicationsSettings --- server_addon/applications/server/settings.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index abfc2c67b7..9e915b6152 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -146,8 +146,8 @@ class ToolGroupModel(BaseSettingsModel): class ApplicationsSettings(BaseSettingsModel): """Applications settings - Define applications are available to your studio, locations of their - executables, and their additional environments. + Define applications available to your studio, locations of their + executables, and their additional environment variables. AYON uses the following definitions to populate the applications list in project anatomy > attributes. From 4d85f56193c359c4dbd6d69f1be0910bb89cce30 Mon Sep 17 00:00:00 2001 From: MustafaJafar Date: Thu, 23 May 2024 12:28:46 +0300 Subject: [PATCH 5/6] revert changes in `Applications settings` docstring --- server_addon/applications/server/settings.py | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index ec6b4ba1d7..6c131a5e9d 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -144,15 +144,7 @@ class ToolGroupModel(BaseSettingsModel): class ApplicationsSettings(BaseSettingsModel): - """Applications settings - - Define applications available to your studio, locations of their - executables, and their additional environment variables. - - AYON uses the following definitions to populate the applications list - in project anatomy > attributes. - So, You'd still need modify your project anatomy settings. - """ + """Applications settings""" maya: AppGroupWithPython = SettingsField( default_factory=AppGroupWithPython, title="Autodesk Maya") From 4359f21c50a796b7afd6913107685999f416c869 Mon Sep 17 00:00:00 2001 From: Mustafa Taher Date: Wed, 29 May 2024 11:19:43 +0300 Subject: [PATCH 6/6] refine the description of `only_available`. Co-authored-by: Roy Nieterau --- server_addon/applications/server/settings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server_addon/applications/server/settings.py b/server_addon/applications/server/settings.py index 6c131a5e9d..3f9d90ef5b 100644 --- a/server_addon/applications/server/settings.py +++ b/server_addon/applications/server/settings.py @@ -214,7 +214,7 @@ class ApplicationsAddonSettings(BaseSettingsModel): only_available: bool = SettingsField( True, title="Show only available applications", - description="Enable to show only available applications in AYON Launcher" + description="Enable to show only applications in AYON Launcher" " for which the executable paths are found on the running machine." " This applies as an additional filter to the applications defined in a " " project's anatomy settings to ignore unavailable applications."