File tree Expand file tree Collapse file tree 1 file changed +4
-1
lines changed
src/labthings_fastapi/descriptors Expand file tree Collapse file tree 1 file changed +4
-1
lines changed Original file line number Diff line number Diff line change @@ -140,7 +140,10 @@ def __init__(
140140 :param initial_value: The initial value of the property. If this is set,
141141 the property must not have a getter, and should behave like a variable.
142142 :param readonly: If True, the property cannot be set via the HTTP API.
143- :param observable: If True, the property can be observed for changes.
143+ :param observable: If True, the property can be observed for changes via
144+ websockets. This causes the setter to run code in the async event loop
145+ that will notify a list of subscribers each time the property is set.
146+ Currently, only websockets can be used to observe properties.
144147 :param description: A description of the property, used in the API documentation.
145148 LabThings will attempt to take this from the docstring if not supplied.
146149 :param title: A human-readable title for the property, used in the API
You can’t perform that action at this time.
0 commit comments