Apply suggestions from code review

krpatter-intc · twm · web-flow · commit d9f72885d3a5 · 2024-12-04T07:30:43.000-06:00
Co-authored-by: Tom Most &lt;twm@freecog.net&gt;
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
`@@ -63,7 +63,7 @@ def _get_default_compare_branch(branches: Container[str]) -> str \| None:`
`63`	`63`	`is_flag=True,`
`64`	`64`	`default=False,`
`65`	`65`	`metavar="STAGED",`
`66`		`- help="include staged files as part of the branch checked in the --compare-with",`
	`66`	`+ help="Include staged files as part of the branch checked in the --compare-with",`
`67`	`67`	`)`
`68`	`68`	`def _main(`
`69`	`69`	`compare_with: str \| None, directory: str \| None, config: str \| None, staged: bool`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-new `--staged` parameter for the `check` to included staged files as part of confirming a news file exists
	`1`	+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