Skip to content

Commit 8a430cc

Browse files
author
Ned Batchelder
committed
docs: --fail-if-warn and --check-links
1 parent 2ab13a2 commit 8a430cc

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/commands.rst

+6
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,12 @@ correspond to a git tag. For example, this changelog entry with the title
208208
If there's no detectable version number in the header, or there isn't a git
209209
tag with the same number, then the entry can't be created as a GitHub release.
210210

211+
The ``--fail-if-warn`` option will end the command if a format conversion
212+
generates a warning, usually because of a missing reference. The
213+
``--check-links`` option will find the URLs in the release description, and
214+
check if they are valid. Warnings are displayed for invalid URLs, but the
215+
command still creates the release.
216+
211217
This command is independent of the other commands. It can be used with a
212218
hand-edited changelog file that wasn't created with scriv.
213219

0 commit comments

Comments
 (0)