change function to build_deprecation_message

Author: cadenmyers13

news/dep-msg-helper.rst

@@ -1,6 +1,6 @@
 **Added:**
 
-* Add ``deprecation_message`` helper for printing consistent deprecation messages.
+* Add ``build_deprecation_message`` helper for printing consistent deprecation messages.
 
 **Changed:**
 

src/diffpy/utils/_deprecator.py

@@ -20,7 +20,9 @@ def deprecated(message, *, category=DeprecationWarning, stacklevel=1):
 
     .. code-block:: python
 
-        from diffpy.utils._deprecator import deprecated, deprecation_message
+        from diffpy.utils._deprecator import (
+            deprecated, build_deprecation_message
+        )
 
         deprecation_warning = build_deprecation_message("diffpy.utils",
                                                         "old_function",
@@ -44,8 +46,9 @@ def new_function(x, y):
 
     .. code-block:: python
 
-        from diffpy.utils._deprecator import deprecated, deprecation_message
-
+        from diffpy.utils._deprecator import (
+            deprecated, build_deprecation_message
+        )
         deprecation_warning = build_deprecation_message("diffpy.utils",
                                                         "OldAtom",
                                                         "NewAtom",
@@ -96,7 +99,7 @@ def wrapper(*args, **kwargs):
     return decorator
 
 
-def deprecation_message(
+def build_deprecation_message(
     old_base, old_name, new_name, removal_version, new_base=None
 ):
     """Generate a deprecation message.

src/diffpy/utils/parsers/loaddata.py

@@ -18,12 +18,12 @@
 import numpy
 
 from diffpy.utils import validators
-from diffpy.utils._deprecator import deprecated, deprecation_message
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
 
 base = "diffpy.utils.parsers.loaddata"
 removal_version = "4.0.0"
 
-loaddata_deprecation_msg = deprecation_message(
+loaddata_deprecation_msg = build_deprecation_message(
     base,
     "loadData",
     "load_data",

tests/test_deprecator.py

@@ -1,13 +1,15 @@
 import pytest
 
-from diffpy.utils._deprecator import deprecated, deprecation_message
+from diffpy.utils._deprecator import build_deprecation_message, deprecated
 
 old_base = "diffpy.utils"
 old_name = "oldFunction"
 new_name = "new_function"
 removal_version = "4.0.0"
 
-dep_msg = deprecation_message(old_base, old_name, new_name, removal_version)
+dep_msg = build_deprecation_message(
+    old_base, old_name, new_name, removal_version
+)
 
 
 @deprecated(dep_msg)