Skip to content

Commit

Permalink
Add clause
Browse files Browse the repository at this point in the history
  • Loading branch information
stinodego committed Jun 4, 2024
1 parent 89bf06f commit a38e221
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/development/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,14 @@ Such changes will not be warned for, but _will_ be included in the changelog and
### Deprecation period

As a rule, deprecated functionality is removed two breaking releases after the deprecation happens.
For example, a function deprecated in version `1.2.3` will be removed in version `3.0.0`.
For example, a function deprecated in version `1.2.3` will be retained in version `2.0.0` and removed in version `3.0.0`.

This means that if your program does not raise any deprecation warnings, it should be mostly safe to upgrade to the next breaking release.
As breaking releases happen about once every three months, this allows three to six months to adjust to any pending breaking changes.
An exception to this rule are deprecations introduced with a breaking release.
These will be enforced on the next breaking release.
For example, a function deprecated in version `2.0.0` will be removed in version `3.0.0`.

This means that if your program does not raise any deprecation warnings, it should be mostly safe to upgrade to the next major version.
As breaking releases happen about once every six months, this allows six to twelve months to adjust to any pending breaking changes.

**In some cases, we may decide to adjust the deprecation period.**
If retaining the deprecated functionality blocks other improvements to Polars, we may shorten the deprecation period to a single breaking release. This will be mentioned in the warning message.
Expand Down

0 comments on commit a38e221

Please sign in to comment.