Changeset 1865 for trunk/python

Timestamp:

08/05/10 17:43:28 (14 years ago)

Author:

Malte Marquarding

Message:

Fixed docstrings fro sphinx

File:

• trunk/python/linecatalog.py (modified) (7 diffs)

trunk/python/linecatalog.py

@@ -1 @@
-"""
+"""\
 A representation of a spectral line catalog.
-
-Author: Malte Marquarding
-
 """
 __revision__ = "$Revision$"
@@ -11 +8 @@
 
 class linecatalog(lcbase):
-    """
+    """\
     This class is a warpper for line catalogs. These can be either ASCII tables
     or the tables saved from this class.
+
     ASCII tables have the following restrictions:
-    Comments can be present through lines starting with '#'.
-    The first column contains the name of the Molecule. This can't contain spaces,
-    if it does it has to be wrapped in ""
-    The second column contains the frequency of the transition.
-    The third column contains the error in frequency.
-    The fourth column contains a value describing the intensity
+
+        * Comments can be present through lines starting with '#'.
+
+        * The first column contains the name of the Molecule. This can't contain
+          spaces, if it does it has to be wrapped in double-quotes.
+
+        * The second column contains the frequency of the transition.
+
+        * The third column contains the error in frequency.
+
+        * The fourth column contains a value describing the intensity.
+
     """
 
@@ -45 +49 @@
 
     def set_name(self, name, mode="pattern"):
-        """
+        """\
         Set a name restriction on the table. This can be a standard unix-style
         pattern or a regular expression.
+
         Parameters:
+
             name:       the name patterrn/regex
+
             mode:       the matching mode, i.e. "pattern" (default) or "regex"
+
         """
         validmodes = "pattern regex".split()
@@ -58 +66 @@
 
     def set_frequency_limits(self, fmin=1.0, fmax=120.0, unit="GHz"):
-        """
+        """\
         Set frequency limits on the table.
+
         Parameters:
+
             fmin:       the lower bound
+
             fmax:       the upper bound
+
             unit:       the frequency unit (default "GHz")
 
-        Note:
-            The underlying table conatins frequency values in MHz
+        .. note:: The underlying table contains frequency values in MHz
         """
         base = { "GHz": 1000.0, "MHz": 1.0 }
@@ -75 +86 @@
 
     def set_strength_limits(self, smin, smax):
-        """
+        """\
         Set line strength limits on the table (arbitrary units)
+
         Parameters:
+
             smin:       the lower bound
+
             smax:       the upper bound
+
         """
         lcbase.set_strength_limits(self, smin, smax)
 
     def save(self, name, overwrite=False):
-        """
+        """\
         Save the subset of the table to disk. This uses an internal data format
         and can be read in again.
@@ -96 +111 @@
 
     def reset(self):
-        """
-        Reset the table to its initial state, i.e. undo all calls to set_
+        """\
+        Reset the table to its initial state, i.e. undo all calls to ``set_``.
         """
         lcbase.reset(self)
 
     def get_row(self, row=0):
+        """\
+        Get the values in a specified row of the table.
+
+        Parameters:
+
+              row:        the row to retrieve
+
         """
-        Get the values in a specified row of the table.
-        Parameters:
-              row:        the row to retrieve
-        """
+        if row < 0 or row > len(self)-1:
+            raise IndexError("Row index out of bounds.")
         freq = lcbase.get_frequency(self, row)
         name = lcbase.get_name(self, row)
@@ -115 +135 @@
 
     def __getitem__(self, k):
-        if k < 0: k = self.nrow()-k
+        if k < 0:
+            k = self.nrow()-k
         return self.get_row(k)