From b8e758e479cdcb821661a444430cdbbd3aed2319 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mose=20M=C3=BCller?= Date: Mon, 8 Jan 2024 15:09:23 +0100 Subject: [PATCH] updates docstring --- src/pydase/server/web_server/sio_setup.py | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/pydase/server/web_server/sio_setup.py b/src/pydase/server/web_server/sio_setup.py index b79793e..8d9a5b9 100644 --- a/src/pydase/server/web_server/sio_setup.py +++ b/src/pydase/server/web_server/sio_setup.py @@ -70,15 +70,12 @@ class UpdateWebSettingsDict(TypedDict): Attributes: ---------- access_path : str - The access path for the component object. This does not have to be an attribute - but can also - For example, for an - attribute access path 'attr1.list_attr[0].attr2', 'attr1.list_attr[0]' would be - the parent_path. + The access path for the component object, e.g. 'attr1.list_attr[0].attr2'. + This does not have to be an attribute but can also be a property or a method. config_option : str - The web setting to be changed, e.g. 'display_name' or 'precision' for - NumberComponents. + The web setting to be changed, e.g. 'display_name' (or 'precision' for + NumberComponents). value : Any The new value to be assigned to the attribute. The type of this value should