betted doc strings

1 files changed, 11 insertions, 5 deletions

diff --git a/qolab/hardware/rf_generator/__init__.py b/qolab/hardware/rf_generator/__init__.py
index 9c99eca..d104fe8 100644
--- a/qolab/hardware/rf_generator/__init__.py
+++ b/qolab/hardware/rf_generator/__init__.py
@@ -2,7 +2,10 @@ from qolab.hardware.scpi import SCPIinstr
 from qolab.hardware.basic import BasicInstrument
 
 class RFGenerator(BasicInstrument):
-    # Minimal set of methods to be implemented by a RFGenerator
+    """Minimal set of methods to be implemented by a RF Generator.
+
+    Intended to be used as a parent for hardware aware classes.
+    """
     def __init__(self, *args, **kwds):
         BasicInstrument.__init__(self, *args, **kwds)
         self.config['Device type']='RFGenerator'
@@ -11,10 +14,13 @@ class RFGenerator(BasicInstrument):
         self.deviceProperties.update({'FreqFixed'})
 
 class RFGeneratorSCPI(SCPIinstr, RFGenerator):
-    """     
-    Do not instantiate directly, use
-    rm = pyvisa.ResourceManager()
-    RFGeneratorSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
+    """SCPI aware RF generator.
+    
+    Example
+    -------
+
+    >>> rm = pyvisa.ResourceManager()
+    >>> RFGeneratorSCPI(rm.open_resource('TCPIP::192.168.0.2::INSTR'))
     """
     def __init__(self, resource, *args, **kwds):
         SCPIinstr.__init__(self, resource)