Skip to content

Commit 8d11075

Browse files
committed
docs: change docstring so API docs are correctly updated
1 parent 4a1ee18 commit 8d11075

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

src/diffpy/utils/_deprecator.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,3 +110,10 @@ def deprecation_message(
110110
f"version {removal_version}. Please use '{new_base}.{new_name}' "
111111
f"instead."
112112
)
113+
114+
115+
_DEPRECATION_DOCSTRING_TEMPLATE = (
116+
"This function has been deprecated and will be "
117+
"removed in version {removal_version}. Please use"
118+
"{new_base}.{new_name} instead."
119+
)

src/diffpy/utils/parsers/loaddata.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@
3636
def loadData(
3737
filename, minrows=10, headers=False, hdel="=", hignore=None, **kwargs
3838
):
39+
"""This function has been deprecated and will be removed in version
40+
4.0.0.
41+
42+
Please use diffpy.utils.parsers.load_data instead.
43+
"""
3944
return load_data(filename, minrows, headers, hdel, hignore, **kwargs)
4045

4146

0 commit comments

Comments
 (0)