From 1925e6ac7f98875eb5980637ae3293e22b459e28 Mon Sep 17 00:00:00 2001 From: David Perl Date: Wed, 18 Jun 2025 11:02:25 +0200 Subject: [PATCH] docs: docstring for config dialog --- .../device_browser/device_item/device_config_dialog.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/bec_widgets/widgets/services/device_browser/device_item/device_config_dialog.py b/bec_widgets/widgets/services/device_browser/device_item/device_config_dialog.py index d03b7949..ce026a70 100644 --- a/bec_widgets/widgets/services/device_browser/device_item/device_config_dialog.py +++ b/bec_widgets/widgets/services/device_browser/device_item/device_config_dialog.py @@ -67,6 +67,15 @@ class DeviceConfigDialog(BECWidget, QDialog): config_helper: ConfigHelper | None = None, **kwargs, ): + """A dialog to edit the configuration of a device in BEC. Generated from the pydantic model + for device specification in bec_lib.atlas_models. + + Args: + parent (QObject): the parent QObject + device (str | None): the name of the device. used with the "update" action to prefill the dialog and validate entries. + config_helper (ConfigHelper | None): a ConfigHelper object for communication with Redis, will be created if necessary. + action (Literal["update", "add"]): the action which the form should perform on application or acceptance. + """ super().__init__(parent=parent, **kwargs) self._config_helper = config_helper or ConfigHelper( self.client.connector, self.client._service_name