Changeset 1858 for trunk/python/asapplotter.py

Timestamp:

08/05/10 11:46:40 (14 years ago)

Author:

Malte Marquarding

Message:

Adde more API documentation

File:

• trunk/python/asapplotter.py (modified) (4 diffs)

trunk/python/asapplotter.py

@@ -14 +14 @@
     By default the plotter is set up to plot polarisations
     'colour stacked' and scantables across panels.
-    Note:
+
+    .. note::
+
         Currenly it only plots 'spectra' not Tsys or
         other variables.
+
     """
     def __init__(self, visible=None , **kwargs):
@@ -113 +116 @@
         self._plotter.tidy()
         self._plotter.show(hardrefresh=False)
-        print_log()
         return
 
@@ -352 +354 @@
 
     def set_panelling(self, what=None):
+        """Set the 'panelling' mode i.e. which type of spectra should be
+        spread across different panels.
+        """
+
         mode = what
         if mode is None:
@@ -382 +388 @@
 
     def set_stacking(self, what=None):
+        """Set the 'stacking' mode i.e. which type of spectra should be
+        overlayed.
+        """
         mode = what
         if mode is None: