Skip to content

Commit

Permalink
Fix an incorrect statement in philosophy about Towncrier only support…
Browse files Browse the repository at this point in the history
…ing RST

The reality is that it is Jinja2 template based and can produce Markdown as well. It just used to be poorly documented. I helped Hynek figure it out for the attrs project at some point.
  • Loading branch information
webknjaz authored and nedbat committed Mar 3, 2024
1 parent ca17b69 commit a12197e
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/philosophy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ None fully embodied scriv's philopsophy.
Tools most similar to scriv:

- `towncrier`_: built for Twisted, with some unusual specifics: fragment type
is the file extension, issue numbers in the file name. Only .rst files.
is the file extension, issue numbers in the file name. Defaults to using
``.rst`` files, but can be configured to produce Markdown or any other
output format, provided enough configuration.

- `blurb`_: built for CPython development, specific to their workflow: issue
numbers from bugs.python.org, only .rst files.
Expand Down

0 comments on commit a12197e

Please sign in to comment.