add tooltips for the transformation inputs

p-j-smith · Sep 13, 2023 · f4ddde2 · f4ddde2
1 parent 7bd28f2
commit f4ddde2
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 7 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -177,6 +177,7 @@ select = [
     "PD",          # pandas-vet
 ]
 ignore = [
+    "A002",        # argument `id` is shadowing a Python builtin
     "E501",        # line too long
     "N802",        # function name lowercase
     "N803",        # argument name should be lowercase

diff --git a/src/mda_tui/widgets/transformations.py b/src/mda_tui/widgets/transformations.py
@@ -22,10 +22,17 @@
 class WidgetWithLabel(Static):
     """Add a label to a widget"""
 
-    def __init__(self, label: str, widget: Static, id: str | None = None) -> None:  # noqa: A002
+    def __init__(
+        self,
+        label: str,
+        widget: Static,
+        id: str | None = None,
+        tooltip: str = "",
+    ) -> None:
+        super().__init__(id=id)
         self.label_text = label
         self.labelled_widget = widget
-        super().__init__(id=id)
+        self.tooltip = tooltip
 
     def compose(self) -> ComposeResult:
         yield Label(self.label_text)
@@ -95,7 +102,15 @@ def compose(self) -> ComposeResult:
             ),
         )
 
-        yield WidgetWithLabel(label="vector", widget=vector, id="translate_vector")
+        # Define tooltips
+        vector_tooltip = "vector by which the all atoms will be translated"
+
+        yield WidgetWithLabel(
+            label="vector",
+            widget=vector,
+            id="translate_vector",
+            tooltip=vector_tooltip,
+        )
 
     @property
     def vector(self):
@@ -169,10 +184,21 @@ def compose(self) -> ComposeResult:
         )
         wrap = Switch()
 
-        yield WidgetWithLabel(label="ag", widget=ag, id="center_ag")
-        yield WidgetWithLabel(label="center", widget=method, id="center_method")
-        yield WidgetWithLabel(label="point", widget=point, id="center_on")
-        yield WidgetWithLabel(label="wrap", widget=wrap, id="center_wrap")
+        # Define tooltips
+        ag_tooltip = "selection string for atom group to be centered on the unit cell. If empty, will center all atoms."
+        method_tooltip = "choose the method of centering on the selected AtomGroup."
+        point_tooltip = "if provided, overrides the unit cell center - the coordinates of each timestep are translated so that the center of mass/geometry of the selected AtomGroup is aligned to this position instead. Leave empty to translate to the center of the unit cell."
+        wrap_tooltip = "if enabled, the atoms from the selected AtomGroup will be moved to the primary unit cell before calculating the center of mass or geometry."
+
+        yield WidgetWithLabel(label="ag", widget=ag, id="center_ag", tooltip=ag_tooltip)
+        yield WidgetWithLabel(
+            label="center",
+            widget=method,
+            id="center_method",
+            tooltip=method_tooltip,
+        )
+        yield WidgetWithLabel(label="point", widget=point, id="center_on", tooltip=point_tooltip)
+        yield WidgetWithLabel(label="wrap", widget=wrap, id="center_wrap", tooltip=wrap_tooltip)
 
     @property
     def selection(self):