mirror of
https://github.com/tiqi-group/pydase.git
synced 2025-04-21 00:40:01 +02:00
updates docstring
This commit is contained in:
parent
a12a708385
commit
b8e758e479
@ -70,15 +70,12 @@ class UpdateWebSettingsDict(TypedDict):
|
|||||||
Attributes:
|
Attributes:
|
||||||
----------
|
----------
|
||||||
access_path : str
|
access_path : str
|
||||||
The access path for the component object. This does not have to be an attribute
|
The access path for the component object, e.g. 'attr1.list_attr[0].attr2'.
|
||||||
but can also
|
This does not have to be an attribute but can also be a property or a method.
|
||||||
For example, for an
|
|
||||||
attribute access path 'attr1.list_attr[0].attr2', 'attr1.list_attr[0]' would be
|
|
||||||
the parent_path.
|
|
||||||
|
|
||||||
config_option : str
|
config_option : str
|
||||||
The web setting to be changed, e.g. 'display_name' or 'precision' for
|
The web setting to be changed, e.g. 'display_name' (or 'precision' for
|
||||||
NumberComponents.
|
NumberComponents).
|
||||||
|
|
||||||
value : Any
|
value : Any
|
||||||
The new value to be assigned to the attribute. The type of this value should
|
The new value to be assigned to the attribute. The type of this value should
|
||||||
|
Loading…
x
Reference in New Issue
Block a user