Updated docs on new loading option

Author: rstoneback

pysatCDF/cdf.py

@@ -343,6 +343,7 @@ def _read_all_attribute_info(self):
         num = copy.deepcopy(self._num_attrs)
         name = copy.deepcopy(self.fname)
         out = fortran_cdf.inquire_all_attr(name, num, len(name))
+        #print (num, name, out)
         status = out[0]
         names = out[1]
         scopes = out[2]
@@ -537,7 +538,18 @@ def _process_return_multi_z_attr(self, data, attr_names, var_names, sub_num_elem
     def to_pysat(self, flatten_twod=True):
         """
         Exports loaded CDF data into data,meta for pysat module
-        
+
+        Parameters
+        ----------
+        flatten_twod : bool (True)
+            If True, then two dimensional data is flattened across 
+            columns. Name mangling is used to group data, first column
+            is 'name', last column is 'name_end'. In between numbers are 
+            appended 'name_1', 'name_2', etc. All data for a given 2D array
+            may be accessed via, data.ix[:,'item':'item_end']
+            If False, then 2D data is stored as a series of DataFrames, 
+            indexed by Epoch. data.ix[0, 'item']
+                             
         Returns
         -------
         data, meta