Updates docstring

ohmpi/hardware_components/abstract_hardware_components.py

@@ -6,6 +6,8 @@ from threading import Event, Barrier, BrokenBarrierError
 
 
 class CtlAbstract(ABC):
+    """CTlAbstract Class
+    Abstract class for controller"""
     def __init__(self, **kwargs):
         self.model = kwargs.pop('model', 'unknown CTL hardware')
         self.interfaces = None
@@ -38,6 +40,8 @@ class CtlAbstract(ABC):
 
 
 class PwrAbstract(ABC):
+    """PwrAbstract Class
+        Abstract class for Power module"""
     def __init__(self, **kwargs):
         self.model = kwargs.pop('model', 'unknown PWR hardware')
         self.exec_logger = kwargs.pop('exec_logger', None)
@@ -127,6 +131,8 @@ class PwrAbstract(ABC):
 
 
 class MuxAbstract(ABC):
+    """MUXAbstract Class
+        Abstract class for MUX"""
     def __init__(self, **kwargs):
         self.model = kwargs.pop('model', 'unknown MUX hardware')
         self.exec_logger = kwargs.pop('exec_logger', create_stdout_logger('exec_mux'))
@@ -270,6 +276,8 @@ class MuxAbstract(ABC):
 
 
 class TxAbstract(ABC):
+    """TxAbstract Class
+        Abstract class for TX module"""
     def __init__(self, **kwargs):
         self.model = kwargs.pop('model', 'unknown TX hardware')
         injection_duration = kwargs.pop('injection_duration', 1.)
@@ -447,6 +455,8 @@ class TxAbstract(ABC):
 
 
 class RxAbstract(ABC):
+    """RXAbstract Class
+        Abstract class for RX"""
     def __init__(self, **kwargs):
         self.exec_logger = kwargs.pop('exec_logger', None)
         if self.exec_logger is None:

ohmpi/hardware_components/mb_2023_0_X.py

@@ -67,6 +67,8 @@ def _ads_1115_gain_auto(channel):  # Make it a class method ?
 
 
 class Tx(TxAbstract):
+    """TX Class
+        """
     def __init__(self, **kwargs):
         if 'model' not in kwargs.keys():
             for key in SPECS['tx'].keys():
@@ -215,6 +217,7 @@ class Tx(TxAbstract):
 
 
 class Rx(RxAbstract):
+    """RX class"""
     def __init__(self, **kwargs):
         if 'model' not in kwargs.keys():
             for key in SPECS['rx'].keys():

ohmpi/hardware_components/mb_2024_0_2.py

@@ -69,6 +69,7 @@ def _ads_1115_gain_auto(channel):  # Make it a class method ?
 
 
 class Tx(Tx_mb_2023):
+    """TX Class"""
     def __init__(self, **kwargs):
         if 'model' not in kwargs.keys():
             for key in SPECS['tx'].keys():
@@ -158,6 +159,7 @@ class Tx(Tx_mb_2023):
 
 
 class Rx(Rx_mb_2023):
+    """RX Class"""
     def __init__(self, **kwargs):
         if 'model' not in kwargs.keys():
             for key in SPECS['rx'].keys():