get_residual_equation

Author: cadenmyers13

src/diffpy/srfit/fitbase/fitcontribution.py

@@ -360,7 +360,17 @@ def set_residual_equation(self, eqstr):
 
         return
 
+    @deprecated(
+        _dep_msg_fitcontrib("getResidualEquation", "get_residual_equation")
+    )
     def getResidualEquation(self):
+        """Deprecated.
+
+        Use get_residual_equation instead.
+        """
+        return self.get_residual_equation()
+
+    def get_residual_equation(self):
         """Get math expression string for the active residual equation.
 
         Return normalized math formula or an empty string if residual

tests/test_contribution.py

@@ -143,15 +143,15 @@ def testReplacements(self):
         self.assertEqual(len(xobs2), len(fc.residual()))
         return
 
-    def test_getResidualEquation(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_releaseOldEquations(self):