Skip to content

Commit 42a8dc1

Browse files
committed
DEP: libdiffpy_version_info.git_sha
Rename to `libdiffpy_version_info.git_commit`.
1 parent 6a2adc6 commit 42a8dc1

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

src/diffpy/srreal/version.py

+11-3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
-----
2121
Variable `__gitsha__` is deprecated as of version 1.3.
2222
Use `__git_commit__` instead.
23+
24+
Variable `libdiffpy_version_info.git_sha` is deprecated as of version 1.4.0.
25+
Use `libdiffpy_version_info.git_commit` instead.
2326
"""
2427

2528
__all__ = ['__date__', '__git_commit__', '__timestamp__', '__version__',
@@ -39,8 +42,11 @@
3942
from collections import namedtuple
4043
from diffpy.srreal.srreal_ext import _get_libdiffpy_version_info_dict
4144

42-
libdiffpy_version_info = namedtuple('libdiffpy_version_info',
43-
"major minor micro patch version_number version date git_sha")
45+
libdiffpy_version_info = namedtuple(
46+
'libdiffpy_version_info',
47+
"major minor micro patch version_number version date git_commit " +
48+
# TODO remove git_sha in version 1.4.
49+
"git_sha")
4450
vd = _get_libdiffpy_version_info_dict()
4551
libdiffpy_version_info = libdiffpy_version_info(
4652
version = vd['version_str'],
@@ -50,7 +56,9 @@
5056
micro = vd['micro'],
5157
patch = vd['patch'],
5258
date = vd['date'],
53-
git_sha = vd['git_sha'])
59+
git_commit = vd['git_commit'],
60+
# TODO remove git_sha in version 1.4.
61+
git_sha = vd['git_commit'])
5462
del vd
5563

5664
# End of file

src/extensions/wrap_libdiffpy_version.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ python::dict get_libdiffpy_version_info_dict()
4343
rv["minor"] = libdiffpy_version_info::minor;
4444
rv["micro"] = libdiffpy_version_info::micro;
4545
rv["date"] = libdiffpy_version_info::date;
46-
rv["git_sha"] = libdiffpy_version_info::git_sha;
46+
rv["git_commit"] = libdiffpy_version_info::git_sha;
4747
rv["patch"] = libdiffpy_version_info::patch;
4848
return rv;
4949
}

0 commit comments

Comments
 (0)