Updated doc headers for THEMIS ASK, GMAG

pyspedas/themis/ground/ask.py

@@ -17,52 +17,70 @@ def ask(site=None,
     """
     This function loads THEMIS All Sky Keograms
 
-    Parameters:
+    Parameters
+    ----------
         site: str
-            Observatory name
-
+            Observatory name, IF set, loads ASF data, not ASK
+            Default: None, all sites are loaded
+            
         trange: list of str
             time range of interest [starttime, endtime] with the format
             'YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
             ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
+            Default: ['2007-03-23', '2007-03-24']
 
         level: str
-            Data type; Valid options: 'l1', 'l2'
+            Data level; Valid options: 'l1'
+            Default: 'l1'
 
         suffix: str
             The tplot variable names will be given this suffix.
-            By default, no suffix is added.
+            Default: no suffix is added
 
         get_support_data: bool
             Data with an attribute "VAR_TYPE" with a value of "support_data"
-            will be loaded into tplot.  By default, only loads in data with a
-            "VAR_TYPE" attribute of "data".
+            will be loaded into tplot.  
+            Default: False; only loads data with a "VAR_TYPE" attribute of "data"
 
         varformat: str
             The file variable formats to load into tplot.  Wildcard character
-            "*" is accepted.  By default, all variables are loaded in.
+            "*" is accepted.
+            Default: None; all variables are loaded
 
         varnames: list of str
             List of variable names to load
-            (if not specified, all data variables are loaded)
+            Default: Empty list, so all data variables are loaded
 
         downloadonly: bool
             Set this flag to download the CDF files, but not load them into
             tplot variables
+            Default: False
 
         notplot: bool
             Return the data in hash tables instead of creating tplot variables
+            Default: False
 
         no_update: bool
             If set, only load data from your local cache
+            Default: False
 
         time_clip: bool
             Time clip the variables to exactly the range specified
             in the trange keyword
-
-    Returns:
-        List of tplot variables created.
-
+            Default: False
+
+    Returns
+    -------
+        List of str
+        List of tplot variables created
+        Empty list if no data
+    
+    Example
+    -------
+        import pyspedas
+        from pytplot import tplot
+        >>> ask_vars = pyspedas.themis.ask(trange=['2013-11-05', '2013-11-06'])
+        >>> tplot(['thg_ask_atha', 'thg_ask_chbg'])
     """
 
     return load(instrument='ask', trange=trange, level=level, datatype=datatype,

pyspedas/themis/ground/gmag.py

@@ -19,55 +19,75 @@ def gmag(trange=['2007-03-23', '2007-03-24'],
     """
     This function loads ground magnetometer data
 
-    Parameters:
-        trange: list of str
+    Parameters
+    ----------
+        trange : list of str
             time range of interest [starttime, endtime] with the format
             'YYYY-MM-DD','YYYY-MM-DD'] or to specify more or less than a day
             ['YYYY-MM-DD/hh:mm:ss','YYYY-MM-DD/hh:mm:ss']
+            Default: ['2007-03-23', '2007-03-24']
 
         level: str
-            Data type; Valid options: 'l1', 'l2'
+            Data level; Valid options: 'l2'
+            Default: 'l2'
 
         suffix: str
             The tplot variable names will be given this suffix.
-            By default, no suffix is added.
+            Default: no suffix
 
         get_support_data: bool
             Data with an attribute "VAR_TYPE" with a value of "support_data"
-            will be loaded into tplot.  By default, only loads in data with a
-            "VAR_TYPE" attribute of "data".
+            will be loaded into tplot.  
+            Default: False; only loads data with a "VAR_TYPE" attribute of "data"
 
         varformat: str
             The file variable formats to load into tplot.  Wildcard character
-            "*" is accepted.  By default, all variables are loaded in.
+            "*" is accepted.
+            Default: None; all variables are loaded
 
         varnames: list of str
             List of variable names to load
-            (if not specified, all data variables are loaded)
+            Default: Empty list, so all data variables are loaded
 
         downloadonly: bool
             Set this flag to download the CDF files, but not load them into
             tplot variables
+            Default: False
 
         notplot: bool
             Return the data in hash tables instead of creating tplot variables
+            Default: False
 
         no_update: bool
             If set, only load data from your local cache
+            Default: False
 
         time_clip: bool
             Time clip the variables to exactly the range specified
             in the trange keyword
+            Default: False
 
         sites: str/list of str
             GMAG station names to load (e.g. 'bmls').
+            Default: None, all available sites are loaded
 
         group: str
-            GMAG group of stations (eg. 'epo').
-            If specified, stations is ignored.
-
-    Returns:
-        List of tplot variables created.
+            GMAG group of sites (eg. 'epo').
+            If specified, sites input is ignored.
+            Default: None
+
+    Returns
+    -------
+        List of str
+        List of tplot variables created
+        Empty list if no data
+    
+    Example
+    -------
+        import pyspedas
+        from pytplot import tplot
+        >>> gmag_vars = pyspedas.themis.gmag(sites=['ccnv','bmls'], trange=['2013-11-05', '2013-11-06'])
+        >>> tplot(['thg_mag_bmls', 'thg_mag_ccnv'])
 
     """