Skip to content

Commit b90f56a

Browse files
committed
fix import bug
1 parent 67e3db5 commit b90f56a

File tree

1 file changed

+1
-38
lines changed

1 file changed

+1
-38
lines changed

src/diffpy/utils/_deprecator.py

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def wrapper(*args, **kwargs):
9696
return decorator
9797

9898

99-
def build_deprecation_message(
99+
def deprecation_message(
100100
old_base, old_name, new_name, removal_version, new_base=None
101101
):
102102
"""Generate a deprecation message.
@@ -131,40 +131,3 @@ def build_deprecation_message(
131131
f"version {removal_version}. Please use '{new_base}.{new_name}' "
132132
f"instead."
133133
)
134-
135-
136-
def generate_deprecation_docstring(new_name, removal_version, new_base=None):
137-
"""Generate a docstring for copy-pasting into a deprecated function.
138-
139-
this function will print the text to the terminal for copy-pasting
140-
141-
usage:
142-
python
143-
>>> import diffpy.utils._deprecator.generate_deprecation_docstring as gdd
144-
>>> gdd("new_name", "4.0.0")
145-
146-
The message looks like:
147-
This function has been deprecated and will be removed in version
148-
{removal_version}. Please use {new_base}.{new_name} instead.
149-
150-
Parameters
151-
----------
152-
new_name: str
153-
The name of the new function or class to replace the existing one
154-
removal_version: str
155-
The version when the deprecated item is targeted for removal,
156-
e.g., 4.0.0
157-
new_base: str Optional. Defaults to old_base.
158-
The new base for importing. The new import statement would look like
159-
"from new_base import new_name"
160-
161-
Returns
162-
-------
163-
None
164-
"""
165-
print(
166-
f"This function has been deprecated and will be "
167-
f"removed in version {removal_version}. Please use"
168-
f"{new_base}.{new_name} instead."
169-
)
170-
return

0 commit comments

Comments
 (0)