fix: fix deprecation message and rename the snakecase method to be consistent.

Author: stevenhua0320

news/deprecate-symmetryutilities-1.rst

@@ -1,6 +1,6 @@
 **Added:**
 
-* Added ``is_space_group_lat_par`` method in ``symmetryutilities.py``
+* Added ``is_space_group_latt_parms`` method in ``symmetryutilities.py``
 * Added ``is_constant_formula`` method in ``symmetryutilities.py``
 
 **Changed:**

src/diffpy/structure/pdffitstructure.py

@@ -22,8 +22,8 @@
 removal_version = "4.0.0"
 readStr_deprecation_msg = build_deprecation_message(
     base,
-    "isSpaceGroupLatPar",
-    "is_space_group_lat_par",
+    "readStr",
+    "read_structure",
     removal_version,
 )
 

src/diffpy/structure/symmetryutilities.py

@@ -39,7 +39,7 @@
 isSpaceGroupLatPar_deprecation_msg = build_deprecation_message(
     base,
     "isSpaceGroupLatPar",
-    "is_space_group_lat_par",
+    "is_space_group_latt_parms",
     removal_version,
 )
 isconstantFormula_deprecation_msg = build_deprecation_message(
@@ -63,12 +63,12 @@ def isSpaceGroupLatPar(spacegroup, a, b, c, alpha, beta, gamma):
     """'diffpy.structure.isSpaceGroupLatPar' is deprecated and will be
     removed in version 4.0.0.
 
-    Please use 'diffpy.structure.is_space_group_lat_par' instead.
+    Please use 'diffpy.structure.is_space_group_latt_parms' instead.
     """
-    return is_space_group_lat_par(spacegroup, a, b, c, alpha, beta, gamma)
+    return is_space_group_latt_parms(spacegroup, a, b, c, alpha, beta, gamma)
 
 
-def is_space_group_lat_par(spacegroup, a, b, c, alpha, beta, gamma):
+def is_space_group_latt_parms(spacegroup, a, b, c, alpha, beta, gamma):
     """Check if space group allows passed lattice parameters.
 
     Parameters

tests/test_symmetryutilities.py

@@ -28,7 +28,7 @@
     _Position2Tuple,
     expandPosition,
     is_constant_formula,
-    is_space_group_lat_par,
+    is_space_group_latt_parms,
     isconstantFormula,
     isSpaceGroupLatPar,
     pruneFormulaDictionary,
@@ -78,19 +78,19 @@ def test_is_space_group_lat_par(self):
         trigonal = GetSpaceGroup("P3")
         hexagonal = GetSpaceGroup("P6")
         cubic = GetSpaceGroup("P23")
-        self.assertTrue(is_space_group_lat_par(triclinic, 1, 2, 3, 40, 50, 60))
-        self.assertFalse(is_space_group_lat_par(monoclinic, 1, 2, 3, 40, 50, 60))
-        self.assertTrue(is_space_group_lat_par(monoclinic, 1, 2, 3, 90, 50, 90))
-        self.assertFalse(is_space_group_lat_par(orthorhombic, 1, 2, 3, 90, 50, 90))
-        self.assertTrue(is_space_group_lat_par(orthorhombic, 1, 2, 3, 90, 90, 90))
-        self.assertFalse(is_space_group_lat_par(tetragonal, 1, 2, 3, 90, 90, 90))
-        self.assertTrue(is_space_group_lat_par(tetragonal, 2, 2, 3, 90, 90, 90))
-        self.assertFalse(is_space_group_lat_par(trigonal, 2, 2, 3, 90, 90, 90))
-        self.assertTrue(is_space_group_lat_par(trigonal, 2, 2, 2, 80, 80, 80))
-        self.assertFalse(is_space_group_lat_par(hexagonal, 2, 2, 2, 80, 80, 80))
-        self.assertTrue(is_space_group_lat_par(hexagonal, 2, 2, 3, 90, 90, 120))
-        self.assertFalse(is_space_group_lat_par(cubic, 2, 2, 3, 90, 90, 120))
-        self.assertTrue(is_space_group_lat_par(cubic, 3, 3, 3, 90, 90, 90))
+        self.assertTrue(is_space_group_latt_parms(triclinic, 1, 2, 3, 40, 50, 60))
+        self.assertFalse(is_space_group_latt_parms(monoclinic, 1, 2, 3, 40, 50, 60))
+        self.assertTrue(is_space_group_latt_parms(monoclinic, 1, 2, 3, 90, 50, 90))
+        self.assertFalse(is_space_group_latt_parms(orthorhombic, 1, 2, 3, 90, 50, 90))
+        self.assertTrue(is_space_group_latt_parms(orthorhombic, 1, 2, 3, 90, 90, 90))
+        self.assertFalse(is_space_group_latt_parms(tetragonal, 1, 2, 3, 90, 90, 90))
+        self.assertTrue(is_space_group_latt_parms(tetragonal, 2, 2, 3, 90, 90, 90))
+        self.assertFalse(is_space_group_latt_parms(trigonal, 2, 2, 3, 90, 90, 90))
+        self.assertTrue(is_space_group_latt_parms(trigonal, 2, 2, 2, 80, 80, 80))
+        self.assertFalse(is_space_group_latt_parms(hexagonal, 2, 2, 2, 80, 80, 80))
+        self.assertTrue(is_space_group_latt_parms(hexagonal, 2, 2, 3, 90, 90, 120))
+        self.assertFalse(is_space_group_latt_parms(cubic, 2, 2, 3, 90, 90, 120))
+        self.assertTrue(is_space_group_latt_parms(cubic, 3, 3, 3, 90, 90, 90))
         return
 
     def test_sgtbx_spacegroup_aliases(self):