impoved doc string

1 files changed, 14 insertions, 12 deletions

diff --git a/qolab/hardware/power_supply/keysight_e3612a.py b/qolab/hardware/power_supply/keysight_e3612a.py
index 76d568e..8000c56 100644
--- a/qolab/hardware/power_supply/keysight_e3612a.py
+++ b/qolab/hardware/power_supply/keysight_e3612a.py
@@ -26,8 +26,8 @@ class KeysightE3612A(PowerSupplySCPI):
         # used if no empirical way to calculate it via Vout/Iout
 
     def getChandV(self, chNum):
-        """
-        Voltage precision per channel.
+        """Get voltage precision per channel.
+
         Obtained from data sheet.
         Alternative estimate is by assuming 14 bit precision from the maximum reading.
         """
@@ -36,8 +36,8 @@ class KeysightE3612A(PowerSupplySCPI):
         return 1.5e-3
 
     def getChandI(self, chNum):
-        """
-        Current precision per channel.
+        """Current precision per channel.
+
         Obtained from data sheet.
         Alternative estimate is by assuming 14 bit precision from the maximum reading.
         """
@@ -46,8 +46,8 @@ class KeysightE3612A(PowerSupplySCPI):
         return 0.160e-3  # see specification for high current > 20mA
 
     def getOpMode(self):
-        """
-        Queries power supply operation mode, returns OFF|PAR|SER|TRAC
+        """ Queries power supply operation mode, returns OFF|PAR|SER|TRAC.
+
         OFF stands for independent channels
         """
         qstr = "OUTP:PAIR?"
@@ -120,17 +120,19 @@ class KeysightE3612A(PowerSupplySCPI):
         return float(rstr)
 
     def setChanIout_mA(self, chNum, val, **kwds):
-        """
-        Set current in mA.
-        Calls setChanIout with val converted from mA to A
+        """Set current in mA.
+
+        Calls setChanIout with val converted from mA to A.
         """
         return self.setChanIout(chNum, val / 1000.0, **kwds)
 
     @BasicInstrument.tsdb_append
     def setChanIout(self, chNum, val, currentHeadRoom=1e-3, dwellTime=0.3):
-        """
-        Tuning Vout to achieve desired Iout.
-        Generally setting current limit will maintain current near but not exact to desired.
+        """Set current in the channel.
+
+        We will tune Vout to achieve desired Iout.
+        Generally setting current limit will maintain current near
+        but not exact to desired value.
         Since Vlimit can be set with good precision,
         this function will try tune Vlimit until the Idesired is reached.
         """