Add note that to build's --version requires command to be explicitly …

…passed (#511)
twisted · May 8, 2023 · b3a2d7f · b3a2d7f
1 parent d626a90
commit b3a2d7f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -39,6 +39,8 @@ Build the combined news file from news fragments.
    Use ``VERSION`` in the rendered news file.
    Can be configured or guessed (default).
 
+   This option requires the ``build`` command to be explicitly passed.
+
 .. option:: --date DATE
 
    The date in `ISO format <https://xkcd.com/1179/>`_ to use in the news file.

diff --git a/src/towncrier/newsfragments/511.doc b/src/towncrier/newsfragments/511.doc
@@ -0,0 +1 @@
+Add a note about the build command's ``--version`` requiring the command to be explicitly passed.