Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-23239

Update deprecation procedure to avoid generating warnings from LSST code

    XMLWordPrintable

    Details

      Description

      Per RFC-659, update the deprecation procedure documented in the Developer Guide to (something like; some wordsmithing may be required):

      An interface may not be deprecated if doing so would cause other DM-provided code to emit a deprecation warning (of course, this does not apply to end-user code). This means that the ticket which adds the deprecation must also remove all remaining calls to the deprecated interface (updating them to the intended replacement, where appropriate). In some cases, it may be impossible to fully remove the calls to the deprecated code (for example, because it is used to implement some user-facing functionality which is also being deprecated); in this eventuality, the lsst.utils.deprecated.suppress_deprecations decorator may be used to temporarily suppress the warning.

        Attachments

          Issue Links

          is triggered by

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-659 Update deprecation procedure to avoid generating warnings from LSST code

          • Adopted

            Activity

            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            Although I tend to write a lot of parentheticals, they do tend to be harder to read. I would make the first a new sentence, the second a comma-separated clause, and the third also a comma-separated clause, but starting with ", typically because it is used". I'd also consider turning the semicolon into a new sentence.

            I like the wording, though.

            Show
            ktl Kian-Tat Lim added a comment - Although I tend to write a lot of parentheticals, they do tend to be harder to read. I would make the first a new sentence, the second a comma-separated clause, and the third also a comma-separated clause, but starting with ", typically because it is used". I'd also consider turning the semicolon into a new sentence. I like the wording, though.

              People

              Assignee:
              swinbank John Swinbank
              Reporter:
              swinbank John Swinbank
              Watchers:
              John Swinbank, Kian-Tat Lim, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.