-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Adjust the deprecation policy to be time based #5572
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -195,19 +195,19 @@ reworked and resubmitted for the next release. | |
Deprecation Policy | ||
================== | ||
|
||
Any change to pip that removes or significantly alters user-visible behaviour | ||
Any change to pip that removes or significantly alters user-visible behavior | ||
that is described in the pip documentation will be deprecated for a minimum of | ||
one released version before the change occurs. Deprecation will take the form of | ||
a warning being issued by pip when the feature is used. Longer deprecation | ||
periods, or deprecation warnings for behaviour changes that would not normally | ||
be covered by this policy, are also possible depending on circumstances, but | ||
this is at the discretion of the pip developers. | ||
6 months before the change occurs. Deprecation will take the form of a warning | ||
being issued by pip when the feature is used. Longer deprecation periods, or | ||
deprecation warnings for behavior changes that would not normally be covered by | ||
this policy, are also possible depending on circumstances, but this is at the | ||
discretion of the pip developers. | ||
|
||
Note that the documentation is the sole reference for what counts as agreed | ||
behaviour. If something isn't explicitly mentioned in the documentation, it can | ||
behavior. If something isn't explicitly mentioned in the documentation, it can | ||
be changed without warning, or any deprecation period, in a pip release. | ||
However, we are aware that the documentation isn't always complete - PRs that | ||
document existing behaviour with the intention of covering that behaviour with | ||
document existing behavior with the intention of covering that behavior with | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Aha. British English and American English spellings. 😄 |
||
the above deprecation process are always acceptable, and will be considered on | ||
their merits. | ||
|
||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
Formally document our deprecation process | ||
Formally document our deprecation process as a minimum of 6 months of deprecation | ||
warnings. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dstufft "one released version" is a 3 month period whereas this says 6 months. Is that intentional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(I'd noticed the 6 month earlier but I didn't realize the time frame got changed until now.)