boundsToRestraints deprecation

Author: cadenmyers13

src/diffpy/srfit/fitbase/fitrecipe.py

@@ -119,6 +119,10 @@
     base, "getBounds2", "get_bounds_array", removal_version
 )
 
+boundsToRestraints_dep_msg = build_deprecation_message(
+    base, "boundsToRestraints", "convert_bounds_to_restraints", removal_version
+)
+
 
 class FitRecipe(_fitrecipe_interface, RecipeOrganizer):
     """FitRecipe class.
@@ -1420,7 +1424,7 @@ def plot_recipe(self, ax=None, return_fig=False, **kwargs):
             else:
                 return figures, axes_list
 
-    def boundsToRestraints(self, sig=1, scaled=False):
+    def convert_bounds_to_restraints(self, sig=1, scaled=False):
         """Turn all bounded parameters into restraints.
 
         The bounds become limits on the restraint.
@@ -1442,6 +1446,17 @@ def boundsToRestraints(self, sig=1, scaled=False):
             )
         return
 
+    @deprecated(boundsToRestraints_dep_msg)
+    def boundsToRestraints(self, sig=1, scaled=False):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use diffpy.srfit.fitbase.FitRecipe.convert_bounds_to_restraints
+        instead.
+        """
+        self.convert_bounds_to_restraints(sig, scaled)
+        return
+
     def _apply_values(self, p):
         """Apply variable values to the variables."""
         if len(p) == 0:

src/diffpy/srfit/fitbase/parameter.py

@@ -55,7 +55,7 @@ class Parameter(_parameter_interface, Argument, Validatable):
     bounds
         A 2-list defining the bounds on the Parameter. This can be
         used by some optimizers when the Parameter is varied. See
-        FitRecipe.get_bounds_pairs and FitRecipe.boundsToRestraints.
+        FitRecipe.get_bounds_pairs and FitRecipe.convert_bounds_to_restraints.
     """
 
     def __init__(self, name, value=None, const=False):
@@ -239,7 +239,7 @@ def bounds(self):
 
         This can be used by some optimizers when the Parameter is
         varied. See FitRecipe.get_bounds_pairs and
-        FitRecipe.boundsToRestraints.
+        FitRecipe.convert_bounds_to_restraints.
         """
         return self.par.bounds