Update deprecation/removal docs to point to labels/milestones instead #3087
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The-Compiler
approved these changes
Jan 5, 2018
asottile
reviewed
Jan 5, 2018
doc/en/backwards-compatibility.rst
Outdated
| @@ -15,91 +15,6 @@ We will only remove deprecated functionality in major releases (e.g. if we depre | |||
| Deprecation Roadmap | |||
| ------------------- | |||
|
|
|||
| This page lists deprecated features and when we plan to remove them. It is important to list the feature, the version where it got deprecated and the version we plan to remove it. | |||
| We track deprecation and removal of features using milestones and the `deprecation <https://github.com/pytest-dev/pytest/labels/type%3A%20deprecation>`_ and `removal <https://github.com/pytest-dev/pytest/labels/type%3A%20removal>`_ labels on GitHub. | |||
There was a problem hiding this comment.
should we perhaps link to the label page which shows both open and closed? (for example https://github.com/pytest-dev/pytest/issues?q=label%3A%22type%3A+deprecation%22)
Using milestones and proper issues are a much saner way to handle these topics than keeping them in sync in a separate document
nicoddemus
force-pushed
the
deprecation-roadmap
branch
from
5ee235e to
cb6b851
Compare
RonnyPfannschmidt
approved these changes
Jan 11, 2018
|
The label for
I think the feature is being deprecated now, would it make more sense to say this?
|
|
@hugovk good point, fixed. Thanks! |
|
By the way, I found your deprecations and removals docs really clear and useful, and started a similar one for Pillow. Thanks! |
|
Awesome, thanks for the feedback, we appreciate it! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Using milestones and proper issues are a much saner way to handle these topics
than keeping them in sync in a separate document.
I was worried how to keep them in sync until this solution occurred to me. I already created the labels and related issues.