Skip to content

Commit

Permalink
Mention orphan fragments in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
SmileyChris committed Apr 25, 2024
1 parent 7384137 commit d12ecb3
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ If the fragments directory does not exist, it will be created.
If the filename exists already, ``towncrier create`` will add (and then increment) a number after the fragment type until it finds a filename that does not exist yet.
In the above example, it will generate ``123.bugfix.1.rst`` if ``123.bugfix.rst`` already exists.

To create a news fragment not tied to a specific issue, start the fragment name with a ``+``. If that is the entire fragment name, a random hash will be added for you::
To create a news fragment not tied to a specific issue (which towncrier calls an "orphan fragment"), start the fragment name with a ``+``.
If that is the entire fragment name, a random hash will be added for you::

$ towncrier create +.feature.rst
$ ls newsfragments/
Expand Down

0 comments on commit d12ecb3

Please sign in to comment.