news

sbillinge · sbillinge · commit c3bd3b84423b · 2026-01-18T09:45:15.000-05:00
diff --git a/news/deprecator.rst b/news/deprecator.rst
@@ -1,5 +1,6 @@
 **Added:**
 
+* added a function in _deprecator to generate a deprecation message for copy pasting
 * Add ``@deprecated`` decorator.
 
 **Changed:**
diff --git a/src/diffpy/utils/_deprecator.py b/src/diffpy/utils/_deprecator.py
@@ -133,6 +133,10 @@ def generate_deprecation_docstring(new_name, removal_version, new_base=None):
       >>> import diffpy.utils._deprecator.generate_deprecation_docstring as gdd
       >>> gdd("new_name", "4.0.0")
 
+    The message looks like:
+      This function has been deprecated and will be removed in version
+      {removal_version}. Please use  {new_base}.{new_name} instead.
+
     Parameters
     ----------
     new_name: str
