From 05f1d0d3efb8f4c08085bb4a8241a72e7e5ede48 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 7 Jul 2018 11:07:13 -0300 Subject: [PATCH] Update README for CHANGELOG about using multiple paragraphs --- changelog/README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/changelog/README.rst b/changelog/README.rst index e34bd4da2..47e21fb33 100644 --- a/changelog/README.rst +++ b/changelog/README.rst @@ -26,7 +26,7 @@ changelog using that instead. If you are not sure what issue type to use, don't hesitate to ask in your PR. -Note that the ``towncrier`` tool will automatically -reflow your text, so it will work best if you stick to a single paragraph, but multiple sentences and links are OK -and encouraged. You can install ``towncrier`` and then run ``towncrier --draft`` +``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries +other than ``features`` it is usually better to stick to a single paragraph to keep it concise. You can install +``towncrier`` and then run ``towncrier --draft`` if you want to get a preview of how your change will look in the final release notes.