From a522fc745af6c8a62de613c621cf0bda402d8df0 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 7 Jul 2018 10:43:37 -0300 Subject: [PATCH 1/4] Small tweaks to the changelog entries --- changelog/2220.bugfix.rst | 6 +++--- changelog/3576.feature.rst | 2 +- changelog/3610.feature.rst | 2 +- changelog/3623.feature.rst | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/changelog/2220.bugfix.rst b/changelog/2220.bugfix.rst index bc74b44bb..a0385e657 100644 --- a/changelog/2220.bugfix.rst +++ b/changelog/2220.bugfix.rst @@ -1,3 +1,3 @@ -In case a (direct) parameter of a test overrides some fixture upon which the -test depends indirectly, do the pruning of the fixture dependency tree. That -is, recompute the full set of fixtures the test function needs. +Fix a bug where fixtures overriden by direct parameters (for example parametrization) were being instantiated +even if they were not being used by a test. + diff --git a/changelog/3576.feature.rst b/changelog/3576.feature.rst index a2af6f9d9..6763a00e6 100644 --- a/changelog/3576.feature.rst +++ b/changelog/3576.feature.rst @@ -1 +1 @@ -``Node.add_marker`` now supports an append=True/False to determine whether the mark comes last (default) or first. +``Node.add_marker`` now supports an ``append=True/False`` parameter to determine whether the mark comes last (default) or first. diff --git a/changelog/3610.feature.rst b/changelog/3610.feature.rst index fd044b4b2..a98295ce8 100644 --- a/changelog/3610.feature.rst +++ b/changelog/3610.feature.rst @@ -1 +1 @@ -Added the `--trace` option to enter the debugger at the start of a test. +New ``--trace`` option to enter the debugger at the start of a test. diff --git a/changelog/3623.feature.rst b/changelog/3623.feature.rst index 2e6f4c428..589d858b9 100644 --- a/changelog/3623.feature.rst +++ b/changelog/3623.feature.rst @@ -1 +1 @@ -introduce ``pytester.copy_example`` as helper to do acceptance tests against examples from the project +Introduce ``pytester.copy_example`` as helper to do acceptance tests against examples from the project. From 1cd62f8c3803e54d57be5555d6cd0a625c489353 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 7 Jul 2018 11:02:33 -0300 Subject: [PATCH 2/4] Update CHANGELOG template to put issue links at the start of entries This allows us to use the new multi-line entries available with towncrier 18.6.0 --- changelog/_template.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog/_template.rst b/changelog/_template.rst index a898abc15..5de4ae97e 100644 --- a/changelog/_template.rst +++ b/changelog/_template.rst @@ -14,7 +14,7 @@ {% if definitions[category]['showcontent'] %} {% for text, values in sections[section][category]|dictsort(by='value') %} {% set issue_joiner = joiner(', ') %} -- {{ text }}{% if category != 'vendor' %} ({% for value in values|sort %}{{ issue_joiner() }}`{{ value }} `_{% endfor %}){% endif %} +- {% for value in values|sort %}{{ issue_joiner() }}`{{ value }} `_{% endfor %}: {{ text }} {% endfor %} From 05f1d0d3efb8f4c08085bb4a8241a72e7e5ede48 Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 7 Jul 2018 11:07:13 -0300 Subject: [PATCH 3/4] 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. From 803302e70c4f1393bee7595d945802071d92723a Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 7 Jul 2018 11:11:08 -0300 Subject: [PATCH 4/4] Fix end-of-line in 2220.bugfix.rst --- changelog/2220.bugfix.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/changelog/2220.bugfix.rst b/changelog/2220.bugfix.rst index a0385e657..e15101131 100644 --- a/changelog/2220.bugfix.rst +++ b/changelog/2220.bugfix.rst @@ -1,3 +1 @@ -Fix a bug where fixtures overriden by direct parameters (for example parametrization) were being instantiated -even if they were not being used by a test. - +Fix a bug where fixtures overriden by direct parameters (for example parametrization) were being instantiated even if they were not being used by a test.