Adequate notes to setuptools-scm declared intentions.

pyscaffold · Jun 21, 2022 · f06fc4c · f06fc4c
1 parent 47eab8e
commit f06fc4c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -394,8 +394,7 @@ How can I configure and debug the exact version exported by my package?
 Why do I see the error ``AssertionError: Can't parse version ...``?
     The way ``setuptools-scm`` parses git tags has some edge cases leading
     to this assertion error. The best way is to either remove the tag or
-    rename it to either a proper semantic version like ``v0.4.2`` or avoid
-    using any number (e.g. ``draft``).
+    rename it to a proper semantic version like ``v0.4.2``.
 
     Please also note that ``setuptools-scm`` may also fail if a single commit
     has multiple tags and at least one of them is problematic (``setuptools-scm``

diff --git a/docs/migration.rst b/docs/migration.rst
@@ -44,7 +44,7 @@ Let's start:
    You can do that by running ``python -m setuptools_scm`` (after installing it
    in your environment). If the command succeeds you are good to go.
 
-   Please note that some very specific tag formats can be problematic.
+   Please note that some specific tag formats can be problematic.
    Check our :ref:`version-faq` for a workaround for this problem.
 
 #. In order to check that everything works, run ``pip install .`` and ``tox -e build``