Skip to content

Commit 6e6c18e

Browse files
add code comments for comprehending backward compatibility code
1 parent cdda768 commit 6e6c18e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

setuptools_scm/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ def dump_version(root, version, write_to, template=None):
6161
def _do_parse(root, parse):
6262
pretended = os.environ.get(PRETEND_KEY)
6363
if pretended:
64+
# we use meta here since the pretended version
65+
# must adhere to the pep to begin with
6466
return meta(pretended)
6567

6668
if parse:
@@ -70,6 +72,8 @@ def _do_parse(root, parse):
7072
"version parse result was a string\n"
7173
"please return a parsed version",
7274
category=DeprecationWarning)
75+
# we use ScmVersion here in order to keep legacy code working
76+
# for 2.0 we should use meta
7377
parse_result = ScmVersion(parse_result)
7478
version = parse_result or _version_from_entrypoint(
7579
root, 'setuptools_scm.parse_scm_fallback')

0 commit comments

Comments
 (0)