From b2e1b37a5ae720c28e663398d29fdb92004b772b Mon Sep 17 00:00:00 2001 From: Gahyun Suh Date: Fri, 1 Dec 2023 03:12:43 +0000 Subject: [PATCH] feat: add tooltips for 'Job Attachments FileSystem' config options in GUI Signed-off-by: Gahyun Suh --- .../client/ui/dialogs/deadline_config_dialog.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/src/deadline/client/ui/dialogs/deadline_config_dialog.py b/src/deadline/client/ui/dialogs/deadline_config_dialog.py index 805e29186..2abd5ebf7 100644 --- a/src/deadline/client/ui/dialogs/deadline_config_dialog.py +++ b/src/deadline/client/ui/dialogs/deadline_config_dialog.py @@ -256,12 +256,21 @@ def _build_farm_settings_ui(self, group, layout): self.handle_background_exception ) layout.addRow(default_storage_profile_box_label, self.default_storage_profile_box) - self.file_system_box = self._init_combobox_setting( + + job_attachments_file_system_tooltip = ( + "This setting determines how job attachments are loaded on the worker instance. " + "'COPIED' downloads all job attachments to disk before rendering begins, while " + "'VIRTUAL' downloads attachments only when needed by each Task. 'COPIED' may be " + "faster if every Task needs all attachments, while 'VIRTUAL' may perform better " + "if tasks only require a subset of attachments." + ) + self.job_attachments_file_system_box = self._init_combobox_setting( group, layout, "defaults.job_attachments_file_system", "Job Attachments FileSystem Options", ["COPIED", "VIRTUAL"], + tooltip=job_attachments_file_system_tooltip, ) def _build_general_settings_ui(self, group, layout): @@ -336,6 +345,7 @@ def _init_combobox_setting( setting_name: str, label_text: str, values: List[str], + tooltip: Optional[str] = None, ): """ Creates a combobox setting and adds it to the specified group and layout. This function also connects state @@ -355,6 +365,9 @@ def _init_combobox_setting( combo_box = QComboBox(parent=group) layout.addRow(label, combo_box) combo_box.addItems(values) + if tooltip: + label.setToolTip(tooltip) + combo_box.setToolTip(tooltip) def refresh_combo_box(): """Function that refreshes the state of the combo box based on the setting name"""