add doc for validate_parameters in each model

src/echosms/dcmmodel.py

@@ -26,7 +26,11 @@ def __init__(self):
         self.max_ka = 20  # [1]
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
         super()._present_and_in(p, ['boundary_type'], self.boundary_types)
         super()._present_and_positive(p, ['medium_rho', 'medium_c', 'a', 'b', 'f'])

src/echosms/dwbamodel.py

@@ -22,7 +22,11 @@ def __init__(self):
         self.max_ka = 20
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+        
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
 
     def calculate_ts_single(self, theta, phi, f, target_rho, target_c, validate_parameters=True):

src/echosms/esmodel.py

@@ -24,7 +24,11 @@ def __init__(self):
         self.max_ka = 20  # [1]
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+        
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
         super()._present_and_in(p, ['boundary_type'], self.boundary_types)
         super()._present_and_positive(p, ['medium_rho', 'medium_c', 'a', 'f',

src/echosms/kamodel.py

@@ -24,7 +24,11 @@ def __init__(self):
         self.no_expand_parameters = ['mesh']
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
         super()._present_and_in(p, ['boundary_type'], self.boundary_types)
         super()._present_and_positive(p, ['medium_c', 'f'])

src/echosms/mssmodel.py

@@ -28,7 +28,11 @@ def __init__(self):
         self.max_ka = 20  # [1]
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+
+        """
         p = as_dict(params)
         super()._present_and_in(p, ['boundary_type'], self.boundary_types)
         super()._present_and_positive(p, ['medium_rho', 'a', 'f'])

src/echosms/psmsmodel.py

@@ -26,7 +26,11 @@ def __init__(self):
         self.max_ka = 10  # [1]
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+        
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
         super()._present_and_in(p, ['boundary_type'], self.boundary_types)
         super()._present_and_positive(p, ['medium_c', 'medium_rho', 'a', 'b', 'f'])

src/echosms/ptdwbamodel.py

@@ -21,7 +21,11 @@ def __init__(self):
         self.no_expand_parameters = ['volume', 'voxel_size', 'rho', 'c']
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+        
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
 
     def calculate_ts_single(self, volume, theta, phi, f, voxel_size, rho, c,

src/echosms/sdwbamodel.py

@@ -22,7 +22,11 @@ def __init__(self):
         self.max_ka = 20
 
     def validate_parameters(self, params):
-        """Validate the model parameters."""
+        """Validate the model parameters.
+        
+        See [here][echosms.ScatterModelBase.validate_parameters] for calling details.
+        """
+
         p = as_dict(params)
 
     def calculate_ts_single(self, theta, phi, f, target_rho, target_c, validate_parameters=True):