From b3a2d7f0a54af78b27f8149614a7a16348ff37bd Mon Sep 17 00:00:00 2001 From: Chris Beaven Date: Tue, 9 May 2023 09:43:58 +1200 Subject: [PATCH] Add note that to build's --version requires command to be explicitly passed (#511) --- docs/cli.rst | 2 ++ src/towncrier/newsfragments/511.doc | 1 + 2 files changed, 3 insertions(+) create mode 100644 src/towncrier/newsfragments/511.doc diff --git a/docs/cli.rst b/docs/cli.rst index 22697d01..af03c784 100644 --- 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 `_ to use in the news file. diff --git a/src/towncrier/newsfragments/511.doc b/src/towncrier/newsfragments/511.doc new file mode 100644 index 00000000..a7d3e9cc --- /dev/null +++ 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.