MAINT: applied suggestions

Applied suggestions from code review.

Co-authored-by: Russell Stoneback <[email protected]>

ACKNOWLEDGEMENTS.md

@@ -19,8 +19,10 @@ Programs
 
 Disclaimers
 ===========
-Any opinions, findings, and conclusions or recommendations expressed in this
-material are those of the author(s) and do not necessarily reflect the views
+Any opinions or actions taken by the listed funding institutions are those of 
+the institutions and do not necessarily reflect the views of the pysat development
+team or individual authors. Any opinions, findings, and conclusions or recommendations 
+expressed in this material are those of the author(s) and do not necessarily reflect the views
 of the funding agencies.
 
 Support and Thanks

docs/supported_instruments.rst

@@ -14,7 +14,7 @@ Meter (IVM) Madrigal data.
 DMSP_SSJ
 --------
 
-Supports the Defense Meteorological Satelitte Program (DMSP) Special Sensor J
+Supports the Defense Meteorological Satellite Program (DMSP) Special Sensor J
 (SSJ) Madrigal data.
 
 
@@ -88,7 +88,7 @@ support (e.g., cleaning methods, experiment acknowledgements, and references).
 NGDC_AE
 -------
 
-An instrument for the Geophysical indices from NGDC, which include AE AL, AU,
+An instrument for the Geophysical indices from NGDC, which include AE, AL, AU,
 and AO.  The :py:attr:`name` is AE due to the Madrigal naming conventions.  The
 data set spans the years of 1978 through 1987, will all data saved in a single
 file.  Because of this, you only need to download the data once and any desired
@@ -101,7 +101,7 @@ time period may be loaded.
 OMNI2_IMF
 ---------
 
-An instrument for the interplanetary magnetic field (IMF) data from Omni 2. The
+An instrument for the interplanetary magnetic field (IMF) data from OMNI 2. The
 data starts in 1963 and the entire data set is contained in a single file.  The
 file is occasionally updated, and so obtaining the most recent data means that
 all historic data must also be downloaded (or re-downloaded). OMNI data may

pysatMadrigal/instruments/ngdc_ae.py

@@ -101,14 +101,7 @@
 
 
 def init(self):
-    """Initialize the Instrument object in support of Madrigal access.
-
-    Parameters
-    ----------
-    kindat : str
-        Madrigal instrument experiment code(s). (default='')
-
-    """
+    """Initialize the Instrument object in support of Madrigal access."""
     # Set the standard pysat attributes
     self.acknowledgements = general.cedar_rules()
     self.references = ''.join(['Davis, T. Neil and Masahisa Sugiura. “Auroral',
@@ -126,8 +119,8 @@ def clean(self):
 
     Note
     ----
-    Supports 'clean', 'dusty', 'dirty' in the sense that it prints
-    a message noting there is no cleaning.
+    Supports 'clean', 'dusty', 'dirty' in the sense that all
+    levels use the flag to clean data the same way.
     'None' is also supported as it signifies no cleaning.
 
     Routine is called by pysat, and not by the end user directly.

pysatMadrigal/instruments/omni2_imf.py

@@ -7,7 +7,7 @@
 # DISTRIBUTION STATEMENT A: Approved for public release. Distribution is
 # unlimited.
 # ----------------------------------------------------------------------------
-"""Supports access to OMNI 2 IMF data archieved at Madrigal.
+"""Supports access to OMNI 2 IMF data archived at Madrigal.
 
 Properties
 ----------
@@ -109,14 +109,7 @@
 
 
 def init(self):
-    """Initialize the Instrument object in support of Madrigal access.
-
-    Parameters
-    ----------
-    kindat : str
-        Madrigal instrument experiment code(s). (default='')
-
-    """
+    """Initialize the Instrument object in support of Madrigal access."""
     # Set the standard pysat attributes
     self.acknowledgements = ''.join([general.cedar_rules(), '\nFor full ',
                                      'acknowledgement info, please see: ',
@@ -225,9 +218,9 @@ def load(fnames, tag='', inst_id=''):
     if data.index[-1] > madrigal_end:
         pysat.logger.critical(''.join(['There is data beyond ',
                                        '{:}'.format(madrigal_end), ' in the ',
-                                       'Omni2 IMF file, please notify the ',
+                                       'OMNI2 IMF file, please notify the ',
                                        'pysatMadrigal developers so that they ',
-                                       'can update this Instrument']))
+                                       'can update this Instrument.']))
 
     # Select the data for the desired time period
     data = data[fstart:fstop]