summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDiego Elio Pettenò <flameeyes@flameeyes.com>2020-03-25 14:29:03 +0000
committerDiego Elio Pettenò <flameeyes@flameeyes.com>2020-03-25 14:29:03 +0000
commit46753eec69de32c69db60ffabf2990ca81db7608 (patch)
treee79c9bc690748f23bb02edff4c271994b2b94b00
parent69eb0fa5660645a9b28c078b5b3e8dddc74267fa (diff)
downloadsetuptools-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.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index f0400f0..3a23414 100644
--- a/README.rst
+++ b/README.rst
@@ -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>`_).