add CLI doc update

twisted · Dec 4, 2024 · 69c78a6 · 69c78a6
1 parent 9832f04
commit 69c78a6
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -121,3 +121,10 @@ By default, ``towncrier`` compares the current branch against ``origin/main`` (a
    Use ``REMOTE-BRANCH`` instead of ``origin/main``::
 
       $ towncrier check --compare-with origin/trunk
+
+.. option:: --staged
+
+   Include files that have been staged for commit when checking for news fragments
+
+      $ towncrier check --staged
+      $ towncrier check --staged --compare-with origin/trunk