diff options
author | Diego Elio Pettenò <flameeyes@flameeyes.com> | 2020-03-25 14:29:03 +0000 |
---|---|---|
committer | Diego Elio Pettenò <flameeyes@flameeyes.com> | 2020-03-25 14:29:03 +0000 |
commit | 46753eec69de32c69db60ffabf2990ca81db7608 (patch) | |
tree | e79c9bc690748f23bb02edff4c271994b2b94b00 | |
parent | 69eb0fa5660645a9b28c078b5b3e8dddc74267fa (diff) | |
download | setuptools-scm-46753eec69de32c69db60ffabf2990ca81db7608.tar.gz |
Fix documentation of `tag_regex` parameter.
Since 5853b0c72be9bf30701e58d9d72b413cb62ff1c9 (July 2018), the regex is
expected to have a single group, named `version` or unnamed.
-rw-r--r-- | README.rst | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -363,9 +363,9 @@ The currently supported configuration keys are: supplying ``__file__``. :tag_regex: - A Python regex string to extract the version part from any SCM tag. - The regex needs to contain three named groups prefix, version and suffix, - where ``version`` captures the actual version information. + A Python regex string to extract the version part from any SCM tag. + The regex needs to contain either a single match group, or a group + named ``version``, that captures the actual version information. Defaults to the value of ``setuptools_scm.config.DEFAULT_TAG_REGEX`` (see `config.py <src/setuptools_scm/config.py>`_). |