# HG changeset patch
# User David Douard <david.douard@logilab.fr>
# Date 1198020330 -3600
# Node ID fb8aa055f6e42827954d43fdeb9198fe5fba5e2a
# Parent  de9122b5680a09198c63c40747f9047401ccd64d
docstrings added

diff -r de9122b5680a -r fb8aa055f6e4 HP3562A/dump_datablock.py
--- a/HP3562A/dump_datablock.py	Wed Dec 19 00:19:25 2007 +0100
+++ b/HP3562A/dump_datablock.py	Wed Dec 19 00:25:30 2007 +0100
@@ -5,7 +5,10 @@
 
 
 class HP3562dumper(prologix.GPIB):
-
+    """
+    Class dedicated to dump data blocks from HP3562A DSA (trace,
+    internal state or coordinate).
+    """
     MODES = {'trace': 'DD',
              'state': 'DS',
              'coord': 'DC',
@@ -20,6 +23,12 @@
         super(HP3562dumper, self).__init__(device, baudrate, timeout, address, mode=1)
 
     def dump(self, mode='trace', format="binary"): 
+        """
+        Dump the required data block and return it as a raw string buffer.
+
+        'mode' can be 'trace' [default], 'state' or 'coord'.
+        'format' can be 'binary' [default], 'ascii' or 'ansi'.
+        """
         format = format.lower()
         mode = mode.lower()
         assert mode in self.MODES
diff -r de9122b5680a -r fb8aa055f6e4 HP3562A/enum_types.py
--- a/HP3562A/enum_types.py	Wed Dec 19 00:19:25 2007 +0100
+++ b/HP3562A/enum_types.py	Wed Dec 19 00:25:30 2007 +0100
@@ -1,4 +1,7 @@
 # -*- coding: utf-8 -*-
+"""
+Constants used for HP3562A data block interpretation.
+"""
 
 EDSP = {0: "No data",
         1: "Frequency response",