chore: docformatter

Author: sbillinge

src/diffpy/srfit/equation/equationmod.py

@@ -20,12 +20,18 @@
 Arguments. The non-constant arguments are accessible as attributes of the
 Equation instance and can be passed as arguments to __call__.
 
-Example > # make a Literal tree. Here's a simple one > add = AdditionOperator()
-> a = Argument(name="a") # Don't forget to name these! > b = Argument(name="b")
-> add.addLiteral(a) > add.addLiteral(b) > # make an Equation instance and pass
-the root > eq = Equation(root = add) > eq(a=3, b=4) # returns 7 > eq(a=2) #
-remembers b=4, returns 6 > eq.a.setValue(-3) > eq.b.setValue(3) > eq() # uses
-last assignment of a and b, returns 0
+Example
+> # make a Literal tree. Here's a simple one
+> add = AdditionOperator()
+> a = Argument(name="a") # Don't forget to name these!
+> b = Argument(name="b")
+> add.addLiteral(a)
+> add.addLiteral(b)
+> # make an Equation instance and pass the root > eq = Equation(root = add)
+> eq(a=3, b=4) # returns 7 > eq(a=2) # remembers b=4, returns 6
+> eq.a.setValue(-3)
+> eq.b.setValue(3)
+> eq() # uses last assignment of a and b, returns 0
 
 See the class documentation for more information.
 """

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

@@ -21,9 +21,8 @@
 
 Literal networks can be evaluated or have other actions performed on them by
 Visitors (in diffpy.srfit.equation.visitors). The Literal-Visitor relationship
-is that described by the Visitor pattern (
-
-http://en.wikipedia.org/wiki/Visitor_pattern).
+is that described by the Visitor pattern
+(http://en.wikipedia.org/wiki/Visitor_pattern).
 """
 
 __all__ = ["Argument", "Operator", "BinaryOperator", "CustomOperator",

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

@@ -19,9 +19,8 @@
 (diffpy.srfit.equation.literals). Visitors are used to validate, print and
 extracting Arguments from Literal networks.
 
-The Literal-Visitor relationship is that described by the Visitor pattern (
-
-http://en.wikipedia.org/wiki/Visitor_pattern).
+The Literal-Visitor relationship is that described by the Visitor pattern
+(http://en.wikipedia.org/wiki/Visitor_pattern).
 """
 
 from __future__ import print_function

src/diffpy/srfit/fitbase/constraint.py

@@ -86,7 +86,8 @@ def update(self):
     def _validate(self):
         """Validate my state.
 
-        This validates that par is not None. This validates eq.
+        This validates that par is not None.
+        This validates eq.
 
         Raises SrFitError if validation fails.
         """

src/diffpy/srfit/fitbase/profile.py

@@ -273,8 +273,8 @@ def setCalculationPoints(self, x):
     def loadtxt(self, *args, **kw):
         """Use numpy.loadtxt to load data.
 
-        Arguments are passed to numpy.loadtxt. unpack = True is enforced. The
-        first two arrays returned by numpy.loadtxt are assumed to be x and y.
+        Arguments are passed to numpy.loadtxt. unpack = True is enforced.
+        The first two arrays returned by numpy.loadtxt are assumed to be x and y.
         If there is a third array, it is assumed to by dy. Any other arrays are
         ignored. These are passed to setObservedProfile.
 

src/diffpy/srfit/fitbase/profilegenerator.py

@@ -21,14 +21,22 @@
 
 To define a ProfileGenerator, one must implement the required Parameters and
 ParameterSets as well as overload the __call__ method with the calculation. A
-very simple example is > class Gaussian(ProfileGenerator): > >    def
-__init__(self): >        # Initialize and give this a name >
-ProfileGenerator.__init__(self, "g") >        # Add amplitude, center and width
-parameters >        self.newParameter("amp", 0) >
-self.newParameter("center", 0) >        self.newParameter("width", 0) > >
-def __call__(self, x): >        a = self.amp.getValue() >        x0 =
-self.center.getValue() >        w = self.width.getValue() >        return a *
-exp(-0.5*((x-x0)/w)**2)
+very simple example is
+> class Gaussian(ProfileGenerator):
+>
+>    def __init__(self):
+>        # Initialize and give this a name
+>        ProfileGenerator.__init__(self, "g")
+>        # Add amplitude, center and width parameters
+>        self.newParameter("amp", 0)
+>        self.newParameter("center", 0)
+>        self.newParameter("width", 0)
+>
+>    def __call__(self, x):
+>        a = self.amp.getValue()
+>        x0 = self.center.getValue()
+>        w = self.width.getValue()
+>        return a * exp(-0.5*((x-x0)/w)**2)
 
 More examples can be found in the example directory of the documentation.
 """

src/diffpy/srfit/fitbase/simplerecipe.py

@@ -158,8 +158,8 @@ def setCalculationPoints(self, x):
     def loadtxt(self, *args, **kw):
         """Use numpy.loadtxt to load data.
 
-        Arguments are passed to numpy.loadtxt. unpack = True is enforced. The
-        first two arrays returned by numpy.loadtxt are assumed to be x and y.
+        Arguments are passed to numpy.loadtxt. unpack = True is enforced.
+        The first two arrays returned by numpy.loadtxt are assumed to be x and y.
         If there is a third array, it is assumed to by dy. Any other arrays are
         ignored. These are passed to setObservedProfile.
 

src/diffpy/srfit/tests/speedtest.py

@@ -432,7 +432,15 @@ def profileTest():
     for i in range(1, 9):
         weightedTest(i)
     """
-    """From diffpy.srfit.equation.builder import EquationFactory import random
-    import cProfile cProfile.run('profileTest()', 'prof') import pstats p =
-    pstats.Stats('prof') p.strip_dirs() p.sort_stats('time') p.print_stats(10)
-    profileTest()"""
+    """
+    from diffpy.srfit.equation.builder import EquationFactory
+    import random
+    import cProfile
+    cProfile.run('profileTest()', 'prof')
+    import pstats
+    p = pstats.Stats('prof')
+    p.strip_dirs()
+    p.sort_stats('time')
+    p.print_stats(10)
+    profileTest()
+    """