Merge pull request #170 from cadenmyers13/param-dep

Deprecate: deprecate all methods of `parameters.py`

Author: sbillinge

news/param-dep.rst

@@ -0,0 +1,27 @@
+**Added:**
+
+* Added ``is_constant`` method to ``Parameter``.
+* Added ``bound_range`` method to ``Parameter``.
+* Added ``bound_window`` method to ``Parameter``.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* Deprecated ``isConst`` method of ``Parameter``. Use ``is_constant`` instead.
+* Deprecated ``boundRange`` method of ``Parameter``. Use ``bound_range`` instead.
+* Deprecated ``boundWindow`` method of ``Parameter``. Use ``bound_window`` instead.
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/srfit/equation/builder.py

@@ -493,7 +493,7 @@ def __eval_binary(self, other, OperatorClass, onleft=True):
 
         Other can be an BaseBuilder or a constant.
 
-        Attributes
+        Parameters
         ----------
         onleft
             Indicates that the operator was passed on the left side
@@ -666,7 +666,7 @@ def __call__(self, *args):
 
         This creates a new builder that encapsulates the operation.
 
-        Attributes
+        Parameters
         ----------
         args
             Arguments of the operation.
@@ -730,7 +730,7 @@ def wrapOperator(name, op):
 def wrapFunction(name, func, nin=2, nout=1):
     """Wrap a function in an OperatorBuilder instance.
 
-    Attributes
+    Parameters
     ----------
     name
         The name of the function

src/diffpy/srfit/equation/equationmod.py

@@ -91,7 +91,7 @@ class Equation(Operator):
     def __init__(self, name=None, root=None):
         """Initialize.
 
-        Attributes
+        Parameters
         ----------
         name
             A name for this Equation.

src/diffpy/srfit/equation/literals/argument.py

@@ -62,7 +62,7 @@ def getValue(self):
     def set_value(self, val):
         """Set the value of the Literal.
 
-        Attributes
+        Parameters
         ----------
         val
             The value to assign

src/diffpy/srfit/equation/literals/operators.py

@@ -347,7 +347,7 @@ def __init__(self, op):
 
         Arguments
 
-        Attributes
+        Parameters
         ----------
         op
             A numpy ufunc

src/diffpy/srfit/equation/visitors/__init__.py

@@ -35,7 +35,7 @@
 def getArgs(literal, getconsts=True):
     """Get the Arguments of a Literal tree.
 
-    Attributes
+    Parameters
     ----------
     getconsts
         If True (default), then Arguments designated as constant
@@ -50,7 +50,7 @@ def getArgs(literal, getconsts=True):
 def getExpression(literal, eqskip=None):
     """Get math expression string from the Literal tree object.
 
-    Attributes
+    Parameters
     ----------
     eqskip
         regular expression pattern for Equation objects that should

src/diffpy/srfit/equation/visitors/printer.py

@@ -29,8 +29,6 @@
 class Printer(Visitor):
     """Printer for printing a Literal tree.
 
-    Attributes:
-
     Attributes
     ----------
     eqskip

src/diffpy/srfit/equation/visitors/swapper.py

@@ -38,7 +38,7 @@ class Swapper(Visitor):
     def __init__(self, oldlit, newlit):
         """Initialize.
 
-        Attributes
+        Parameters
         ----------
         oldlit
             The literal to be replaced.

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -147,7 +147,7 @@ def __init__(self, name):
     def set_profile(self, profile, xname=None, yname=None, dyname=None):
         """Assign the Profile for this FitContribution.
 
-        Attributes
+        Parameters
         ----------
         profile
             A Profile that specifies the calculation points and that
@@ -227,7 +227,7 @@ def add_profile_generator(self, gen, name=None):
         Calling addProfileGenerator sets the profile equation to call the
         calculator and if there is not a profile equation already.
 
-        Attributes
+        Parameters
         ----------
         gen
             A ProfileGenerator instance
@@ -278,7 +278,7 @@ def set_equation(self, eqstr, ns={}):
         for this FitContribution.  The equation will be usable within
         set_residual_equation as "eq", and it takes no arguments.
 
-        Attributes
+        Parameters
         ----------
         eqstr
             A string representation of the equation. Any Parameter
@@ -353,7 +353,7 @@ def getEquation(self):
     def set_residual_equation(self, eqstr):
         """Set the residual equation for the FitContribution.
 
-        Attributes
+        Parameters
         ----------
         eqstr
             A string representation of the residual. If eqstr is None

src/diffpy/srfit/fitbase/fithook.py

@@ -58,7 +58,7 @@ def precall(self, recipe):
         """This is called within FitRecipe.residual, before the
         calculation.
 
-        Attributes
+        Parameters
         ----------
         recipe
             The FitRecipe instance
@@ -69,7 +69,7 @@ def postcall(self, recipe, chiv):
         """This is called within FitRecipe.residual, after the
         calculation.
 
-        Attributes
+        Parameters
         ----------
         recipe
             The FitRecipe instance
@@ -88,8 +88,6 @@ class PrintFitHook(FitHook):
     This FitHook prints out a running count of the number of times the residual
     has been called, or other information, based on the verbosity.
 
-    Attributes
-
     Attributes
     ----------
     count
@@ -127,7 +125,7 @@ def precall(self, recipe):
         """This is called within FitRecipe.residual, before the
         calculation.
 
-        Attributes
+        Parameters
         ----------
         recipe
             The FitRecipe instance
@@ -141,7 +139,7 @@ def postcall(self, recipe, chiv):
         """This is called within FitRecipe.residual, after the
         calculation.
 
-        Attributes
+        Parameters
         ----------
         recipe
             The FitRecipe instance
@@ -237,7 +235,7 @@ def postcall(self, recipe, chiv):
 
         Find data and plot it.
 
-        Attributes
+        Parameters
         ----------
         recipe
             The FitRecipe instance