|
| 1 | +.. _develop.policies: |
| 2 | + |
| 3 | +******** |
| 4 | +Policies |
| 5 | +******** |
| 6 | + |
| 7 | +.. _policies.version: |
| 8 | + |
| 9 | +Version Policy |
| 10 | +~~~~~~~~~~~~~~ |
| 11 | + |
| 12 | +.. versionchanged:: 1.0.0 |
| 13 | + |
| 14 | +Pandas uses a loose variant of semantic versioning (`SemVer`_) to govern |
| 15 | +deprecations, API compatibility, and version numbering. |
| 16 | + |
| 17 | +A pandas release number is made up of ``MAJOR.MINOR.PATCH``. |
| 18 | + |
| 19 | +API breaking changes should only occur in **major** releases. Theses changes |
| 20 | +will be documented, with clear guidance on what is changing, why it's changing, |
| 21 | +and how to migrate existing code to the new behavior. |
| 22 | + |
| 23 | +Whenever possible, a deprecation path will be provided rather than an outright |
| 24 | +breaking change. |
| 25 | + |
| 26 | +Pandas will introduce deprecations in **minor** releases. These deprecations |
| 27 | +will preserve the existing behavior while emitting a warning that provide |
| 28 | +guidance on: |
| 29 | + |
| 30 | +* How to achieve similar behavior if an alternative is available |
| 31 | +* The pandas version in which the deprecation will be enforced. |
| 32 | + |
| 33 | +We will not introduce new deprecations in patch releases. |
| 34 | + |
| 35 | +Deprecations will only be enforced in **major** releases. For example, if a |
| 36 | +behavior is deprecated in pandas 1.2.0, it will continue to work, with a |
| 37 | +warning, for all releases in the 1.x series. The behavior will change and the |
| 38 | +deprecation removed in the next next major release (2.0.0). |
| 39 | + |
| 40 | +.. note:: |
| 41 | + |
| 42 | + Pandas will sometimes make *behavior changing* bug fixes, as part of |
| 43 | + minor or patch releases. Whether or not a change is a bug fix or an |
| 44 | + API-breaking change is a judgement call. We'll do our best, and we |
| 45 | + invite you to participate in development discussion on the issue |
| 46 | + tracker or mailing list. |
| 47 | + |
| 48 | +These policies do not apply to features marked as **experimental** in the documentation. |
| 49 | +Pandas may change the behavior of experimental features at any time. |
| 50 | + |
| 51 | +Python Support |
| 52 | +~~~~~~~~~~~~~~ |
| 53 | + |
| 54 | +Pandas will only drop support for specific Python versions (e.g. 3.5.x, 3.6.x) in |
| 55 | +pandas **major** releases. |
| 56 | + |
| 57 | +.. _SemVer: https://semver.org |
0 commit comments