Skip to content

Comments

Improve overall CHANGELOG formatting and consistency for 3.0#1720

Merged
The-Compiler merged 1 commit intopytest-dev:featuresfrom
nicoddemus:changelog-formatting
Jul 13, 2016
Merged

Improve overall CHANGELOG formatting and consistency for 3.0#1720
The-Compiler merged 1 commit intopytest-dev:featuresfrom
nicoddemus:changelog-formatting

Conversation

@nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Jul 13, 2016

Tried to improve overall consistency and formatting of the CHANGELOG for 3.0. Suggestions are welcome!

Rules I tried to follow:

  • Use past or imperative tense ("removed", "add");
  • Reference issue ids at the end of the item;
  • Finish all items with .;

CHANGELOG.rst Outdated
pytest warning (`#1479`_). Thanks to `@The-Compiler`_ for the PR.

* removed support code for python 3 < 3.3 addressing (`#1627`_)
* Removed support code for Python versions < 3.3 addressing (`#1627`_).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should explicitly say "Python 3 versions < 3.3" (or just "Python 3.0 - 3.2" or so?), otherwise this might imply we dropped 2.7 😉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also the parens in "addressing (#1234)" don't make any sense. I'm really not sure where this came from - maybe because older changelog entries said "[Added a] fix (...) for some issue" and then it got cargo-culted and also used like "Fixes (...)" and "addressing (...)". Anyways, we should get rid of it IMHO.

@The-Compiler
Copy link
Member

Seems like there are various places saying "for PR" and "for bug report", I didn't comment on all of them - maybe just add a "the" everywhere 😉

@nicoddemus nicoddemus force-pushed the changelog-formatting branch from 43ac5f7 to 4a763ac Compare July 13, 2016 11:52
@nicoddemus
Copy link
Member Author

Seems like there are various places saying "for PR" and "for bug report", I didn't comment on all of them - maybe just add a "the" everywhere 😉

Done!

We're probably getting into bikeshedding here

Not at all, I appreciate the review. 😁

@coveralls
Copy link

coveralls commented Jul 13, 2016

Coverage Status

Coverage remained the same at 92.225% when pulling 4a763ac on nicoddemus:changelog-formatting into 54ea27c on pytest-dev:features.

@nicoddemus
Copy link
Member Author

@The-Compiler could you merge if you don't have any other comments? I would like to get this in ASAP otherwise chances for conflicts with other PRs increases as time passes. 😁

@The-Compiler The-Compiler merged commit aeccd6b into pytest-dev:features Jul 13, 2016
@The-Compiler
Copy link
Member

And in it is! Thanks!

@nicoddemus
Copy link
Member Author

😄 👍

@nicoddemus nicoddemus deleted the changelog-formatting branch July 13, 2016 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants