From 69c78a64e8f1fd012ccc92b8161c9d16bcfa7ee4 Mon Sep 17 00:00:00 2001
From: "Patterson, Kevin R" <kevin.r.patterson@intel.com>
Date: Tue, 3 Dec 2024 18:40:41 -0600
Subject: [PATCH] add CLI doc update

---
 docs/cli.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/cli.rst b/docs/cli.rst
index c8040461..d462350a 100644
--- 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