Skip to content

Commit

Permalink
Merge pull request #1976 from rhattersley/update-deprecation-docs
Browse files Browse the repository at this point in the history
Update deprecation rules
  • Loading branch information
pp-mo committed Apr 21, 2016
2 parents e2a4552 + d20341b commit e7ef21d
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions docs/iris/src/developers_guide/deprecations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@ Deprecations
************

If you need to make a backwards-incompatible change to a public API
[#public-api]_ that has been included in a release, then you should
only make that change after a deprecation period. This deprecation
period must last at least six months or two public releases, whichever
results in the longer period of time. Once the deprecation period has
expired the deprecated API should be removed/updated in the next
[#public-api]_ that has been included in a release (e.g. deleting a
method), then you must first deprecate the old behaviour in at least
one release, before removing/updating it in the next
`major release <http://semver.org/>`_.


Expand Down Expand Up @@ -74,7 +72,7 @@ Removing a deprecation
======================

When the time comes to make a new major release you should locate any
deprecated APIs within the code that satisfy the six month/two release
deprecated APIs within the code that satisfy the one release
minimum period described previously. Locating deprecated APIs can easily
be done by searching for the Sphinx deprecation directives and/or
deprecation warnings.
Expand Down

0 comments on commit e7ef21d

Please sign in to comment.