Merge remote-tracking branch 'origin/feature/interactive-create' into…

… feature/interactive-create
twisted · Apr 24, 2024 · f02e8f6 · f02e8f6
2 parents e87fcb2 + f071ef8
commit f02e8f6
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/docs/cli.rst b/docs/cli.rst
@@ -72,6 +72,8 @@ Create a news fragment in the directory that ``towncrier`` is configured to look
 
    $ towncrier create 123.bugfix.rst
 
+If you don't provide a file name, ``towncrier`` will prompt you for one.
+
 ``towncrier create`` will enforce that the passed type (e.g. ``bugfix``) is valid.
 
 If the fragments directory does not exist, it will be created.
@@ -84,11 +86,11 @@ In the above example, it will generate ``123.bugfix.1.rst`` if ``123.bugfix.rst`
    A string to use for content.
    Default: an instructive placeholder.
 
-.. option:: --edit
+.. option:: --edit / --no-edit
 
-   Create file and start ``$EDITOR`` to edit the news fragment right away.
+   Whether to start ``$EDITOR`` to edit the news fragment right away.
+   Default: ``$EDITOR`` will be started unless you also provided content.
 
-If you don't provide a file name, ``towncrier`` will prompt you for one, and unless you provided content, it'll also open an editor for you to write the news fragment.
 
 ``towncrier check``
 -------------------