Spelling and documentation fixes.

James Boulton · James Boulton · commit 99913f4d6a4a · 2024-11-06T14:08:43.000+13:00
diff --git a/dashio/iotcontrol/audio_visual_display.py b/dashio/iotcontrol/audio_visual_display.py
@@ -51,7 +51,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the  **Dash** app, by default None
         column_no : int, optional default is 1. Must be 1..3
             The Dash App reports its screen size in columns. column_no allows you to specify which column no to load into.
             Each control can store three configs that define how the device looks for Dash apps installed on single column
@@ -85,7 +85,7 @@ def from_cfg_dict(cls, cfg_dict: dict, column_no=1):
         return tmp_cls
 
     def get_state(self):
-        """get_state is called by iotdashboard
+        """get_state is called by Device
 
         Returns
         -------
diff --git a/dashio/iotcontrol/button.py b/dashio/iotcontrol/button.py
@@ -192,7 +192,7 @@ def from_cfg_dict(cls, cfg_dict: dict, column_no=1):
         return tmp_cls
 
     def get_state(self):
-        """get_state is called by iotdashboard
+        """get_state is called by Device
 
         Returns
         -------
diff --git a/dashio/iotcontrol/chart.py b/dashio/iotcontrol/chart.py
@@ -40,7 +40,7 @@ def __init__(self, name="", line_type=ChartLineType.LINE, color=Color.BLACK, rig
             self.axis_side = 'right'
 
     def get_line_data(self):
-        """Returns the line data formatted for the iotdashboard app
+        """Returns the line data formatted for the **Dash** app
 
         Returns
         -------
@@ -133,7 +133,7 @@ class Chart(Control):
     """
 
     def get_state(self):
-        """Called by iotdashboard"""
+        """Called by Device"""
         state_str = ""
         for key, line in self.line_dict.items():
             state_str += self._control_hdr_str + key + line.get_line_data()
@@ -166,7 +166,7 @@ def __init__(
         control_id : str
             A unique identifier for this control
         title : str, optional
-            The title for this control will be displayed on the iotdashboard app, by default "A Chart"
+            The title for this control will be displayed on the **Dash** app, by default "A Chart"
         title_position : TitlePosition, optional
             The position of the title, by default TitlePosition.BOTTOM
         x_axis_label : str, optional
@@ -313,7 +313,7 @@ def add_line(self, line_id: str, gline: ChartLine):
         self.line_dict[line_id.translate(BAD_CHARS)] = gline
 
     def send_chart(self):
-        """Sends the chart to any connected iotdashboard app.
+        """Sends the chart to any connected  **Dash** app.
         """
         state_str = ""
         for key, line in self.line_dict.items():
diff --git a/dashio/iotcontrol/color_picker.py b/dashio/iotcontrol/color_picker.py
@@ -92,7 +92,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         picker_style: ColorPickerStyle, optional
             The style of color picker to use.
         send_only_on_release: Boolean
diff --git a/dashio/iotcontrol/control.py b/dashio/iotcontrol/control.py
@@ -194,7 +194,7 @@ class ControlConfig:
     """Base ControlConfig"""
 
     def get_cfg_json(self) -> str:
-        """Returns the CFG str for the control called when the iotdashboard app asks for a CFG
+        """Returns the CFG str for the control called when the **Dash** app asks for a CFG
 
         Parameters
         ----------
@@ -211,7 +211,7 @@ def get_cfg_json(self) -> str:
         return cfg_str
 
     def get_cfg64(self) -> dict:
-        """Returns the CFG dict for the control called when the iotdashboard app asks for a CFG
+        """Returns the CFG dict for the control called when the **Dash** app asks for a CFG
 
         Parameters
         ----------
@@ -304,11 +304,11 @@ class Control():
     """Base class for controls. """
 
     def get_state(self) -> str:
-        """This is called by iotdashboard app. Controls need to implement their own version."""
+        """This is called by **Dash** app. Controls need to implement their own version."""
         return ""
 
     def get_cfg(self, data) -> list:
-        """Returns the CFG str for the control called when the iotdashboard app asks for a CFG
+        """Returns the CFG str for the control called when the **Dash** app asks for a CFG
 
         Parameters
         ----------
@@ -337,7 +337,7 @@ def get_cfg(self, data) -> list:
         return cfg_list
 
     def get_cfg64(self, data) -> list:
-        """Returns the CFG dict for the control called when the iotdashboard app asks for a CFG
+        """Returns the CFG dict for the control called when the **Dash** app asks for a CFG
 
         Parameters
         ----------
@@ -381,7 +381,7 @@ def add_receive_message_callback(self, callback):
         self._message_rx_event += callback
 
     def remove_receive_message_callback(self, callback):
-        """Remaove a callback from receive incoming messages to the control."""
+        """Remove a callback from receive incoming messages to the control."""
         self._message_rx_event -= callback
 
     def add_transmit_message_callback(self, callback):
@@ -392,12 +392,12 @@ def remove_transmit_message_callback(self, callback):
         """Remove a callback for transmitted messages from the control."""
         self._message_tx_event -= callback
 
-    def __init__(self, cntrl_type: str, control_id: str):
+    def __init__(self, ctrl_type: str, control_id: str):
         """Control base type - all controls have these characteristics and methods.
 
         Parameters
         ----------
-        cntrl_type : str
+        ctrl_type : str
             The type of control to implement
         control_id : str
             An unique control identity string. The control identity string must be a unique string for each control per device
@@ -412,15 +412,15 @@ def __init__(self, cntrl_type: str, control_id: str):
         self._is_active = False
 
         self._cfg_max_no_columns = 3
-        self.cntrl_type = cntrl_type.translate(BAD_CHARS)
+        self.ctrl_type = ctrl_type.translate(BAD_CHARS)
         self.control_id = control_id.translate(BAD_CHARS)
         if not self.control_id:
             raise ValueError('control_id cannot be an empty string')
         self._message_rx_event = Event()
         self._message_tx_event = Event()
         # This may break things but makes all controls able to be setup from tasks.
         self._message_rx_event += self._message_tx_event
-        self._control_hdr_str = f"\t{{device_id}}\t{self.cntrl_type}\t{self.control_id}\t"
+        self._control_hdr_str = f"\t{{device_id}}\t{self.ctrl_type}\t{self.control_id}\t"
 
     def del_config(self, column_no=1):
         """Deletes all the columnar config layout entries"""
diff --git a/dashio/iotcontrol/device_view.py b/dashio/iotcontrol/device_view.py
@@ -114,7 +114,7 @@ def from_dict(cls, cfg_dict: dict):
 
 class DeviceView(Control):
     """A DeviceView provides a control that describes appearance and style of the group of controls
-        that are displayed on this DeviceView by the iotdashboard app.
+        that are displayed on this DeviceView by the **Dash** app.
 
     Attributes
     ----------
diff --git a/dashio/iotcontrol/dial.py b/dashio/iotcontrol/dial.py
@@ -132,7 +132,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         dial_min : float, optional
             Minimum dial position, by default 0.0
         dial_max : float, optional
diff --git a/dashio/iotcontrol/direction.py b/dashio/iotcontrol/direction.py
@@ -110,7 +110,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         style : DirectionStyle, optional
             The Direction style to display, by default DirectionStyle.DEG
         pointer_color : Color, optional
diff --git a/dashio/iotcontrol/event_log.py b/dashio/iotcontrol/event_log.py
@@ -42,7 +42,7 @@ def __init__(self, lines: str, color=Color.WHITE):
 
         lines : str max 25 lines long. Each line is separated by '\n'
         color : Color, optional
-            The color to display this data point on the iotdashboard app, by default Color.WHITE
+            The color to display this data point on the **Dash** app, by default Color.WHITE
         """
         self.color = color
         self.timestamp = datetime.datetime.utcnow().replace(microsecond=0, tzinfo=datetime.timezone.utc)
@@ -99,7 +99,7 @@ def __init__(
         control_id : str
             A unique identifier for this control
         title : str, optional
-            The title for this control will be displayed on the iotdashboard app, by default "An Event Log"
+            The title for this control will be displayed on the **Dash** app, by default "An Event Log"
         title_position : TitlePosition, optional
             The position of the title, by default TitlePosition.BOTTOM
         control_position : ControlPosition, optional
@@ -160,7 +160,7 @@ def _get_log_from_timestamp(self, msg):
         return data_str
 
     def add_event_data(self, data: EventData):
-        """Add a data point to the log and send it to any connected iotdashboard app
+        """Add a data point to the log and send it to any connected **Dash** app
 
         Parameters
         ----------
@@ -172,10 +172,17 @@ def add_event_data(self, data: EventData):
             self.state_str = self._control_hdr_str + str(data)
 
     def send_event(self, event: EventData):
+        """Send event.
+
+        Parameters
+        ----------
+        event :  EventData
+            The data to send
+        """
         self.state_str = self._control_hdr_str + str(event)
 
     def send_latest_data(self):
-        """Send the latest log entry to any connected iotdashboard app.
+        """Send the latest log entry to any connected **Dash** app.
         """
         if self.log:
             self.state_str = self._control_hdr_str + str(self.log.get_latest())
diff --git a/dashio/iotcontrol/knob.py b/dashio/iotcontrol/knob.py
@@ -124,7 +124,7 @@ def __init__(
         control_id : str
             A unique identifier for this control
         title : str, optional
-            The title for this control will be displayed on the iotdashboard app, by default "A Knob"
+            The title for this control will be displayed on the **Dash** app, by default "A Knob"
         title_position : TitlePosition, optional
             The position of the title, by default TitlePosition.BOTTOM
         knob_style : KnobStyle, optional
diff --git a/dashio/iotcontrol/label.py b/dashio/iotcontrol/label.py
@@ -90,7 +90,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         color : Color, optional
             Color of the label, by default Color.WHITE
         style : LabelStyle, optional
diff --git a/dashio/iotcontrol/menu.py b/dashio/iotcontrol/menu.py
@@ -100,7 +100,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         text : str, optional
             Menu text, by default "A Menu with Text"
         icon : Icon, optional
diff --git a/dashio/iotcontrol/ring_buffer.py b/dashio/iotcontrol/ring_buffer.py
@@ -49,10 +49,10 @@ def get_latest(self):
         """
         if self._full:
             # Get the last item in the buffer
-            indx = self.cur - 1
-            if indx < 0:
-                indx = self.max - 1
-            return self.data[indx]
+            index = self.cur - 1
+            if index < 0:
+                index = self.max - 1
+            return self.data[index]
         return self.data[-1]
 
     def empty(self) -> bool:
diff --git a/dashio/iotcontrol/selector.py b/dashio/iotcontrol/selector.py
@@ -49,7 +49,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         column_no : int, optional default is 1. Must be 1..3
             The Dash App reports its screen size in columns. column_no allows you to specify which column no to load into.
             Each control can store three configs that define how the device looks for Dash apps installed on single column
diff --git a/dashio/iotcontrol/slider.py b/dashio/iotcontrol/slider.py
@@ -124,7 +124,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         bar_min : float, optional
             min bar value, by default 0.0
         bar_max : float, optional
diff --git a/dashio/iotcontrol/table.py b/dashio/iotcontrol/table.py
@@ -167,7 +167,7 @@ def __init__(
         self._max_columns = columns
 
     def get_state(self):
-        return "".join([self._send_row(indx, row) for indx, row in enumerate(self._rows)])
+        return "".join([self._send_row(index, row) for index, row in enumerate(self._rows)])
 
     @classmethod
     def from_cfg_dict(cls, cfg_dict: dict, column_no=1):
diff --git a/dashio/iotcontrol/textbox.py b/dashio/iotcontrol/textbox.py
@@ -125,7 +125,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         text : str, optional
             Text for the textbox, by default ""
         text_align : TextAlignment, optional
diff --git a/dashio/iotcontrol/time_graph.py b/dashio/iotcontrol/time_graph.py
@@ -117,7 +117,7 @@ def get_line_format(self):
         return f"\t{self.name}\t{self.line_type.value}\t{self.color.value}\t{self.axis_side}\n"
 
     def get_line_from_timestamp(self, timestamp: str) -> str:
-        """Converts data from timestamp to a string formatted for the iotdashboard app
+        """Converts data from timestamp to a string formatted for the **Dash** app
 
         Returns
         -------
@@ -162,6 +162,8 @@ def add_data_point(self, data):
             raise TypeError("Not a valid data point")
 
     def add_break(self):
+        """Add graph break to the line.
+        """
         self.timestamp = datetime.datetime.utcnow().replace(microsecond=0, tzinfo=datetime.timezone.utc)
         dp_break = DataPoint("B")
         self.data.append(dp_break)
@@ -265,7 +267,7 @@ def __init__(
         control_position : ControlPosition, optional
             The position of the control on a DeviceView, by default None
         title_position : TitlePosition, optional
-            Position of the title when displayed on the iotdashboard app, by default None
+            Position of the title when displayed on the **Dash** app, by default None
         y_axis_label : str, optional
             Label for the Y axis, by default "Y axis"
         y_axis_min : float, optional
@@ -395,7 +397,7 @@ def _get_lines_from_timestamp(self, msg):
         return state_str
 
     def send_data(self):
-        """Sends the latest Data to the iotdashboard app.
+        """Sends the latest Data to the **Dash** app.
         """
         state_str = ""
         for key, line in self.line_dict.items():
