Merge branch 'developer' into dev/rx_disable_datastream_port

python/slsdet/ctb.py

@@ -27,10 +27,34 @@ class Ctb(Detector):
 
     @property
     def powers(self):
+        """ 
+        [Chiptestboard][Xilinx CTB] Power names and values of all power supplies.
+
+        Example
+        -----------
+        >>> # print all powers with DAC and info if enabled
+        >>> d.powers 
+        >>> # set DAC or enables for power supply VA 
+        >>> d.powers.VA = 1200
+        >>> # enable or disable power subbly VA
+        >>> d.powers.VA.enable()
+        >>> d.powers.VA.disable()
+        >>> # get dac value of power supply VA
+        >>> d.powers.VA.dac
+        >>> # check if power supply VA is enabled
+        >>> d.powers.VA.enabled
+        >>> # print both enabled and dac value of power supply VA
+        >>> d.powers.VA
+        """
         return self._powers
     
     @property
     def powerlist(self):
+        """
+        List of power supply names on the Chip Test Board.
+
+        :setter: List of custom power supply names to set. 
+        """
         return self.getPowerNames()
 
     @powerlist.setter

python/slsdet/detector.py

@@ -827,16 +827,21 @@ class Detector(CppDetectorApi):
     @property
     @element
     def txdelay(self):
-        """
+        r"""
         [Eiger][Jungfrau][Moench][Mythen3] Set transmission delay for all modules in the detector using the step size provided.
         
         Note
         ----
-        Sets up the following for every module:\n
-        \t\t[Eiger] txdelay_left to (2 * mod_index * n_delay), \n
-        \t\t[Eiger] txdelay_right to ((2 * mod_index + 1) * n_delay) and \n
-        \t\t[Eiger] txdelay_frame to (2 *num_modules * n_delay)  \n
-        \t\t[Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules * n_delay)\n\n
+        Sets up the following for every module:
+
+        [Eiger] txdelay_left to (2 \* mod_index \* n_delay), 
+
+        [Eiger] txdelay_right to ((2 \* mod_index + 1) \* n_delay) and 
+
+        [Eiger] txdelay_frame to (2 \* num_modules \* n_delay)  
+
+        [Jungfrau][Moench][Mythen3] txdelay_frame to (num_modules \* n_delay)
+        
         Please refer txdelay_left, txdelay_right and txdelay_frame for details.
         """
         return self.getTransmissionDelay()
@@ -1313,10 +1318,10 @@ class Detector(CppDetectorApi):
     @property
     def zmqhwm(self):
         """
-        Client's zmq receive high water mark. Default is the zmq library's default (1000), can also be set here using -1. 
-        This is a high number and can be set to 2 for gui purposes. 
+        Client's zmq receive high water mark. Default is the zmq library's default (1000), can also be set here using -1.
+        This is a high number and can be set to 2 for gui purposes.
         One must also set the receiver's send high water mark to similar value. Final effect is sum of them.
-	    Setting it via command line is useful only before zmq enabled (before opening gui).
+        Setting it via command line is useful only before zmq enabled (before opening gui).
         """
         return self.getClientZmqHwm()
 
@@ -2312,13 +2317,16 @@ class Detector(CppDetectorApi):
     @property
     @element
     def threshold(self):
-        """[Eiger][Mythen3] Threshold in eV
+        """
+        [Eiger][Mythen3] Threshold in eV
         
         Note
         ----
-        To change settings as well or set threshold without trimbits, use setThresholdEnergy.
+        To change settings as well or set threshold without trimbits, 
+        use setThresholdEnergy.
 
-        :setter: It loads trim files from settingspath.\n [Mythen3] An energy of -1 will pick up values from detector.
+        :setter: It loads trim files from settingspath.\n 
+            [Mythen3] An energy of -1 will pick up values from detector.
         """
         
         if self.type == detectorType.MYTHEN3: