add check_params to modes

Author: TomDonoghue

specparam/modes/mode.py

@@ -83,3 +83,12 @@ def n_params(self):
         """Define property attribute to access the number of parameters."""
 
         return self.params.n_params
+
+
+    def check_params(self):
+        """Check the description of the parameters for the current mode."""
+
+        print('Parameters for the {} component in {} mode:'.format(\
+            self.component, self.name))
+        for pkey, desc in self.params.descriptions.items():
+            print('\t{:15s} {:s}'.format(pkey, desc))

specparam/modes/modes.py

@@ -29,6 +29,13 @@ def __init__(self, aperiodic, periodic):
         self.periodic = check_mode_definition(periodic, PE_MODES)
 
 
+    def check_params(self):
+        """Check the description of the parameters for each mode."""
+
+        self.aperiodic.check_params()
+        self.periodic.check_params()
+
+
     def get_modes(self):
         """Get the modes definition.
 

specparam/tests/modes/test_mode.py

@@ -24,6 +24,7 @@ def tfit(xs, *params):
                  freq_space='linear', powers_space='linear')
     assert tmode
     assert tmode.n_params == params.n_params
+    tmode.check_params()
 
 def test_mode_params_dict():
 

specparam/tests/modes/test_modes.py

@@ -14,6 +14,7 @@ def test_modes():
     assert modes
     assert isinstance(modes.aperiodic, Mode)
     assert isinstance(modes.periodic, Mode)
+    modes.check_params()
 
 def test_modes_get_modes():