Skip to content

Add Deprecation Roadmap to backward compatibility document #2931

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

Merged
merged 2 commits into from
Nov 18, 2017

Conversation

nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Nov 15, 2017

We should replace the wiki document to a link to this document now: https://github.com/pytest-dev/pytest/wiki/Deprecation-Roadmap

Rationale: the Wiki is not really used by us so I doubt users look at it, plus deprecation always involves code so it makes sense to update the document in the same PR.

We should replace the wiki document to a link to this document now
@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.258% when pulling f9029f1 on nicoddemus:deprecation-roadmap-docs into 74aaf91 on pytest-dev:master.

@nicoddemus
Copy link
Member Author

@hackebrot
Copy link
Member

hackebrot commented Nov 18, 2017

Hi @nicoddemus! 👋

I'm not entirely sure about what order I prefer. If we're going to keep it at just two versions it probably doesn't make too much difference, but if we're going to extend the list, I'd like to see the upcoming release first, then any future releases, followed by a section for deprecations in past versions.

@nicoddemus
Copy link
Member Author

Hi @hackebrot!

I'd like to see the upcoming release first, then any future releases, followed by a section for deprecations in past versions.

This is the order that is in the document already... would you like me to change something? It is not very clear to me from your comment if you want me to change something.

@hackebrot
Copy link
Member

hackebrot commented Nov 18, 2017

I think I'd add section headers

  • Upcoming Release
  • Future Releases
  • Past Releases

Or describe the order in the section description.

@nicoddemus
Copy link
Member Author

@hackebrot added Future/Past releases as you suggested. I didn't add a "upcoming" release because I think it will be tedious to maintain it for each release, seems better to just explicitly declare in which versions some things will be removed.

@hackebrot hackebrot self-requested a review November 18, 2017 14:22
Copy link
Member

@hackebrot hackebrot left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@coveralls
Copy link

Coverage Status

Coverage remained the same at 92.258% when pulling b0f558d on nicoddemus:deprecation-roadmap-docs into 74aaf91 on pytest-dev:master.

@nicoddemus
Copy link
Member Author

Thanks for the review! 👍

@nicoddemus nicoddemus merged commit 77bd0aa into pytest-dev:master Nov 18, 2017
@nicoddemus nicoddemus deleted the deprecation-roadmap-docs branch November 18, 2017 14:30
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.

4 participants