Skip to content

Commit

Permalink
Add some documentation explaining the current behavior.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Oct 24, 2023
1 parent 0b023fa commit 002cfd3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ The following options can be passed to all of the commands that explained below:
Build the combined news file from news fragments.
``build`` is also assumed if no command is passed.

If there are no news fragments (including an empty fragments directory), a
notice of "no significant changes" will be added to the news file.

By default, the processed news fragments are removed using ``git``, which will
also remove the fragments directory if now empty.

.. option:: --draft

Only render news fragments to standard output.
Expand Down Expand Up @@ -67,6 +73,8 @@ Create a news fragment in the directory that ``towncrier`` is configured to look

``towncrier create`` will enforce that the passed type (e.g. ``bugfix``) is valid.

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.

Expand Down

0 comments on commit 002cfd3

Please sign in to comment.