Skip to content

Separate issues in the CHANGELOG into sections #1275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nicoddemus opened this issue Dec 22, 2015 · 3 comments
Closed

Separate issues in the CHANGELOG into sections #1275

nicoddemus opened this issue Dec 22, 2015 · 3 comments
Assignees
Labels
type: docs documentation improvement, missing or needing clarification

Comments

@nicoddemus
Copy link
Member

Currently we don't have any organization on how issues are displayed in the CHANGELOG. This makes it harder for people reading it to focus on what might affect then, for example the recent changes in behavior for 2.8 (returning non-zero when no tests were executed, yellow status bar when there are warnings, etc).

In my opinion an excellent introduction to what's changed between versions is the excellent What’s New In Python 3.5, but I think this is too big a change for pytest and would probably need a champion to work properly.

What I propose then is to just create two sections in the CHANGELOG, New Features and Bug Fixes. This would allow people to more easily see the new exciting features and notice changes that might affect then in 2.9 and onward. 😁

So here's what the CHANGELOG would look like:

2.9.0.dev
=========

New Features
------------

* New `pytest.mark.skip` mark, which unconditional skips marked tests.
  Thanks Michael Aquilina for the complete PR.

* `pytest_enter_pdb` now optionally receives the pytest config object.
  Thanks Bruno Oliveira for the PR.

* New `-rp` and `-rP` reporting options give the summary and full output
  of passing tests, respectively. Thanks to David Vierra for the PR.

Bug Fixes/Adjustments
---------------------

* fix issue #680: the -s and -c options should now work under xdist;
  `Config.fromdictargs` now represents its input much more faithfully.
  Thanks to Buck Evan for the complete PR.

* fix #1226: Removed code and documentation for Python 2.5 or lower versions,
  including removal of the obsolete ``_pytest.assertion.oldinterpret`` module.
  Thanks Bruno Oliveira for the PR.

As with #1274, this was also brought up by me while talking with @RonnyPfannschmidt on gtalk. @hpk42, @flub, @The-Compiler, any opinions?

@nicoddemus nicoddemus added the type: docs documentation improvement, missing or needing clarification label Dec 22, 2015
@nicoddemus nicoddemus self-assigned this Dec 22, 2015
@RonnyPfannschmidt
Copy link
Member

👍

@The-Compiler
Copy link
Member

Sure, why not - makes sense!

nicoddemus added a commit to nicoddemus/pytest that referenced this issue Dec 25, 2015
nicoddemus added a commit to nicoddemus/pytest that referenced this issue Dec 25, 2015
@flub
Copy link
Member

flub commented Jan 1, 2016

+1
On 23 Dec 2015 10:41, "Florian Bruhin" [email protected] wrote:

Sure, why not - makes sense!


Reply to this email directly or view it on GitHub
#1275 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

No branches or pull requests

4 participants