Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-213

Deprecation proceedure

    Details

    • Type: RFC
    • Status: Implemented
    • Resolution: Done
    • Component/s: DM
    • Labels:
      None

      Description

      It would be useful to have a standard deprecation procedure to track when a feature is deprecated and how long it will continue to be supported before removal from the stack. Ideally this would be indicated in the doc string, which would note both the date/version the feature was deprecated and the date/version when it will be removed.

        Attachments

          Issue Links

            Activity

            Hide
            fred3m Fred Moolekamp added a comment -

            John Swinbank is a brute!

            I must have misunderstood a conversation I had the other day when I was told that we don't properly version the stack and have a regular release schedule. If that isn't the case, then I agree that we should just deprecate to the next major release. So I'd be happy to adopt this RFC if we're willing to create a ticket for someone to write a deprecation decorator that will make it easier to update the documentation and find features that need to be removed in the next release.

            Show
            fred3m Fred Moolekamp added a comment - John Swinbank is a brute! I must have misunderstood a conversation I had the other day when I was told that we don't properly version the stack and have a regular release schedule. If that isn't the case, then I agree that we should just deprecate to the next major release. So I'd be happy to adopt this RFC if we're willing to create a ticket for someone to write a deprecation decorator that will make it easier to update the documentation and find features that need to be removed in the next release.
            Hide
            tjenness Tim Jenness added a comment -

            Two (at least) triggered tickets are needed. One to obtain an @deprecated decorator (there seem to be loads on line after a two minute search). The other to update the dev guide with the deprecation policy, including an addition to the release process such that release notes will explicitly list the new deprecations and will note the APIs that were removed.

            Show
            tjenness Tim Jenness added a comment - Two (at least) triggered tickets are needed. One to obtain an @deprecated decorator (there seem to be loads on line after a two minute search). The other to update the dev guide with the deprecation policy, including an addition to the release process such that release notes will explicitly list the new deprecations and will note the APIs that were removed.
            Hide
            fred3m Fred Moolekamp added a comment -

            Created DM-8968 and DM-8969 to create deprecation decorator and update dev guide respectively

            Show
            fred3m Fred Moolekamp added a comment - Created DM-8968 and DM-8969 to create deprecation decorator and update dev guide respectively
            Hide
            swinbank John Swinbank added a comment -

            I was told that we don't properly version the stack...

            It's a Humphrey Appleby moment, really. “Almost anything can be attacked as a loss of amenity, and almost anything can be defended as not a significant loss of amenity”. Substitute “properly”, etc.

            Show
            swinbank John Swinbank added a comment - I was told that we don't properly version the stack... It's a Humphrey Appleby moment, really. “Almost anything can be attacked as a loss of amenity, and almost anything can be defended as not a significant loss of amenity”. Substitute “properly”, etc.
            Hide
            swinbank John Swinbank added a comment -

            Fred Moolekamp, Kian-Tat Lim — following RFC-557, can we mark this RFC as “implemented”?

            Show
            swinbank John Swinbank added a comment - Fred Moolekamp , Kian-Tat Lim — following RFC-557 , can we mark this RFC as “implemented”?

              People

              • Assignee:
                fred3m Fred Moolekamp
                Reporter:
                fred3m Fred Moolekamp
                Watchers:
                Fred Moolekamp, Gabriele Comoretto, Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Krzysztof Findeisen, Michael Wood-Vasey, Robert Lupton, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                10 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Planned End:

                  Summary Panel