From 560ca6e9fe4aa76c21b2a9f5a0a47325803f2a65 Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Sat, 10 Jan 2026 16:55:57 +0000 Subject: [PATCH] Tweak a docstring as the variables out of date --- src/openflexure_microscope_server/ui.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/openflexure_microscope_server/ui.py b/src/openflexure_microscope_server/ui.py index 58641a4f..d6c68290 100644 --- a/src/openflexure_microscope_server/ui.py +++ b/src/openflexure_microscope_server/ui.py @@ -50,8 +50,11 @@ class ActionButton(BaseModel): def action_button_for(thing: lt.Thing, action_name: str, **kwargs: Any) -> ActionButton: """Create a ActionButton data for the specified Thing Action. - :param action: The thing action to create a button for. + :param thing: The instance of the thing that has the action. + :param action_name: The name of the action to create a button for. :param kwargs: Any attribute of `ActionButton` except for ``thing`` or ``action``. + :return: An ActionButton (Pydantic Model) object with all the information the + webapp needs to create the action button. """ return ActionButton(thing=thing.name, action=action_name, **kwargs)