Apply suggestions from code review

Co-authored-by: Tom Most <[email protected]>
twisted · Dec 4, 2024 · d9f7288 · d9f7288
1 parent 69c78a6
commit d9f7288
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -124,7 +124,7 @@ By default, ``towncrier`` compares the current branch against ``origin/main`` (a
 
 .. option:: --staged
 
-   Include files that have been staged for commit when checking for news fragments
+   Include files that have been staged for commit when checking for news fragments::
 
       $ towncrier check --staged
       $ towncrier check --staged --compare-with origin/trunk
diff --git a/src/towncrier/check.py b/src/towncrier/check.py
@@ -63,7 +63,7 @@ def _get_default_compare_branch(branches: Container[str]) -> str | None:
     is_flag=True,
     default=False,
     metavar="STAGED",
-    help="include staged files as part of the branch checked in the --compare-with",
+    help="Include staged files as part of the branch checked in the --compare-with",
 )
 def _main(
     compare_with: str | None, directory: str | None, config: str | None, staged: bool

diff --git a/src/towncrier/newsfragments/676.feature.rst b/src/towncrier/newsfragments/676.feature.rst
@@ -1 +1 @@
-new `--staged` parameter for the `check` to included staged files as part of confirming a news file exists
+The `towncrier check` command now has a `--staged` flag to inspect the files staged for commit when checking for a news fragment: useful in a pre-commit hook
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		new `--staged` parameter for the `check` to included staged files as part of confirming a news file exists
		The `towncrier check` command now has a `--staged` flag to inspect the files staged for commit when checking for a news fragment: useful in a pre-commit hook