Skip to content

Commit fd541c7

Browse files
committed
add brief explanation of title_format outside the example
1 parent 0fdef36 commit fd541c7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.rst

+4
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,10 @@ Towncrier has the following global options, which can be specified in the toml f
146146
147147
If a single file is used, the content of that file gets overwritten each time.
148148

149+
If ``title_format`` is unspecified or an empty string, the default format will be used.
150+
If set to ``false``, no title will be created.
151+
This can be useful if the specified template creates the title itself.
152+
149153
Furthermore, you can add your own fragment types using:
150154

151155
.. code-block:: ini

0 commit comments

Comments
 (0)