chore: use Parameters instead of Arguments

Author: ycexiao

docs/source/extending.rst

@@ -180,7 +180,7 @@ external program before or after interfacing with SrFit. An example of a
 customized Profile is the ``SASProfile`` class in the
 ``diffpy.srfit.sas.sasprofile`` module:
 
-.. literalinclude:: /../../src/diffpy/srfit/sas/sasprofile.py
+.. literalinclude:: ../../src/diffpy/srfit/sas/sasprofile.py
    :pyobject: SASProfile
 
 The ``__init__`` method sets the ``xobs``, ``yobs`` and ``dyobs`` attributes of

src/diffpy/srfit/equation/builder.py

@@ -142,8 +142,8 @@ def makeEquation(
     ):
         """Make an equation from an equation string.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         eqstr
             An equation in string form using standard python
             syntax.  The equation string can use any function
@@ -308,8 +308,8 @@ def _prepareBuilders(self, eqstr, buildargs, argclass, argkw):
         arguments, and creates new arguments if allowed. In the process it
         rebuilds the newargs attribute.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         eqstr
             An equation in string as specified in the makeEquation
             method.
@@ -553,8 +553,8 @@ class ArgumentBuilder(BaseBuilder):
     def __init__(self, value=None, name=None, const=False, arg=None):
         """Create an ArgumentBuilder instance, containing a new Argument.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         value
             The value of the wrapped Argument (float, default None)
         name
@@ -594,8 +594,8 @@ class OperatorBuilder(BaseBuilder):
     def __init__(self, name, op=None):
         """Wrap an Operator or a function by name.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         name
             The name of the wrapped Operator
         op

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

@@ -36,8 +36,8 @@ class ArgFinder(Visitor):
     def __init__(self, getconsts=True):
         """Initialize.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         getconsts
             Flag indicating whether to parse constant arguments
             (default True).

src/diffpy/srfit/fitbase/fitrecipe.py

@@ -254,8 +254,8 @@ def removeParameterSet(self, parset):
     def residual(self, p=[]):
         """Calculate the vector residual to be optimized.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         p
             The list of current variable values, provided in the same order
             as the '_parameters' list. If p is an empty iterable (default),
@@ -305,8 +305,8 @@ def residual(self, p=[]):
     def scalarResidual(self, p=[]):
         """Calculate the scalar residual to be optimized.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         p
             The list of current variable values, provided in the same order
             as the '_parameters' list. If p is an empty iterable (default),

src/diffpy/srfit/fitbase/profile.py

@@ -138,8 +138,8 @@ def loadParsedData(self, parser):
     def setObservedProfile(self, xobs, yobs, dyobs=None):
         """Set the observed profile.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         xobs
             Numpy array of the independent variable
         yobs
@@ -280,8 +280,8 @@ def _isobs(a):
     def setCalculationPoints(self, x):
         """Set the calculation points.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         x
             A non-empty numpy array containing the calculation points. If
             xobs exists, the bounds of x will be limited to its bounds.
@@ -414,8 +414,8 @@ def _validate(self):
 def rebinArray(A, xold, xnew):
     """Rebin the an array by interpolating over the new x range.
 
-    Arguments
-    ---------
+    Parameters
+    ----------
     A
         Array to interpolate
     xold

src/diffpy/srfit/fitbase/profileparser.py

@@ -103,8 +103,8 @@ def parseString(self, patstring):
 
         This wipes out the currently loaded data and selected bank number.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         patstring
             A string containing the pattern
 
@@ -117,8 +117,8 @@ def parseFile(self, filename):
 
         This wipes out the currently loaded data and selected bank number.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         filename
             The name of the file to parse
 
@@ -151,8 +151,8 @@ def selectBank(self, index):
         parser is used to parse more data. This uses python list notation, so
         index -n returns the nth bank from the end.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         index
             index of bank (integer, starting at 0).
 
@@ -184,8 +184,8 @@ def getData(self, index=None):
         parser is used to parse more data. This uses python list notation, so
         index -n returns the nth bank from the end.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         index
             index of bank (integer, starting at 0, default None). If
             index is None then the currently selected bank is used.

src/diffpy/srfit/fitbase/simplerecipe.py

@@ -119,8 +119,8 @@ def loadParsedData(self, parser):
     def setObservedProfile(self, xobs, yobs, dyobs=None):
         """Set the observed profile.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         xobs
             Numpy array of the independent variable
         yobs
@@ -172,8 +172,8 @@ def setCalculationRange(self, xmin=None, xmax=None, dx=None):
     def setCalculationPoints(self, x):
         """Set the calculation points.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         x
             A non-empty numpy array containing the calculation points. If
             xobs exists, the bounds of x will be limited to its bounds.

src/diffpy/srfit/pdf/pdfparser.py

@@ -114,8 +114,8 @@ def parseString(self, patstring):
 
         This wipes out the currently loaded data and selected bank number.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         patstring
             A string containing the pattern
 

src/diffpy/srfit/sas/sasparser.py

@@ -94,8 +94,8 @@ def parseFile(self, filename):
 
         This wipes out the currently loaded data and selected bank number.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         filename
             The name of the file to parse
 
@@ -129,8 +129,8 @@ def parseString(self, patstring):
 
         This wipes out the currently loaded data and selected bank number.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         patstring
             A string containing the pattern
 

src/diffpy/srfit/sas/sasprofile.py

@@ -98,8 +98,8 @@ def setObservedProfile(self, xobs, yobs, dyobs=None):
 
         This is overloaded to change the value within the datainfo object.
 
-        Arguments
-        ---------
+        Parameters
+        ----------
         xobs
             Numpy array of the independent variable
         yobs