getResidualEquation deprecation

Author: cadenmyers13

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -70,6 +70,13 @@
     removal_version,
 )
 
+getresidualequation_dep_msg = build_deprecation_message(
+    base,
+    "getResidualEquation",
+    "get_residual_equation",
+    removal_version,
+)
+
 
 class FitContribution(ParameterSet):
     """FitContribution class.
@@ -397,7 +404,7 @@ def setResidualEquation(self, eqstr):
         self.set_residual_equation(eqstr)
         return
 
-    def getResidualEquation(self):
+    def get_residual_equation(self):
         """Get math expression string for the active residual equation.
 
         Return normalized math formula or an empty string if residual
@@ -410,6 +417,18 @@ def getResidualEquation(self):
             rv = getExpression(self._reseq, eqskip="eq$")
         return rv
 
+    @deprecated(getresidualequation_dep_msg)
+    def getResidualEquation(self):
+        """This function has been deprecated and will be removed in version
+        4.0.0.
+
+        Please use
+        diffpy.srfit.fitbase.FitContribution.get_residual_equation
+        instead.
+        """
+
+        return self.get_residual_equation()
+
     def residual(self):
         """Calculate the residual for this fitcontribution.
 

tests/test_contribution.py

@@ -158,23 +158,23 @@ def testReplacements(self):
     def test_get_residual_equation(self):
         """Check getting the current formula for residual equation."""
         fc = self.fitcontribution
-        self.assertEqual("", fc.getResidualEquation())
+        self.assertEqual("", fc.get_residual_equation())
         fc.set_profile(self.profile)
         fc.set_equation("A * x + B")
-        self.assertEqual("((eq - y) / dy)", fc.getResidualEquation())
+        self.assertEqual("((eq - y) / dy)", fc.get_residual_equation())
         fc.set_residual_equation("2 * (eq - y)")
-        self.assertEqual("(2 * (eq - y))", fc.getResidualEquation())
+        self.assertEqual("(2 * (eq - y))", fc.get_residual_equation())
         return
 
     def test_getResidualEquation(self):
         """Check getting the current formula for residual equation."""
         fc = self.fitcontribution
-        self.assertEqual("", fc.getResidualEquation())
+        self.assertEqual("", fc.get_residual_equation())
         fc.set_profile(self.profile)
         fc.set_equation("A * x + B")
         self.assertEqual("((eq - y) / dy)", fc.getResidualEquation())
         fc.setResidualEquation("2 * (eq - y)")
-        self.assertEqual("(2 * (eq - y))", fc.getResidualEquation())
+        self.assertEqual("(2 * (eq - y))", fc.get_residual_equation())
         return
 
     def test_releaseOldEquations(self):