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

System for deprecating Config fields

    Details

    • Story Points:
      2
    • Sprint:
      AP F19-1, AP F19-2
    • Team:
      Alert Production

      Description

      While working on DM-20154, I wanted to mark a Config field as deprecated, but we have no system for doing that (other than just adding a docstring). Kian-Tat Lim suggested an approach on slack, which was fairly simple to implement. I'll also add a note to the dev guide on how to use it as part of this ticket.

        Attachments

          Issue Links

            Activity

            Show
            Parejkoj John Parejko added a comment - Jenkins: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/30039/pipeline
            Hide
            Parejkoj John Parejko added a comment -

            Kian-Tat Lim I know you looked at it as part of the RFC, but can you please review this change to pex_config and the dev guide?

            Here is a rendered version of the dev guide (still waiting on DM-20448 to get the pipelines links to work): https://developer.lsst.io/v/DM-20378/stack/deprecating-interfaces.html#config-deprecation

            Show
            Parejkoj John Parejko added a comment - Kian-Tat Lim I know you looked at it as part of the RFC, but can you please review this change to pex_config and the dev guide? Here is a rendered version of the dev guide (still waiting on DM-20448 to get the pipelines links to work): https://developer.lsst.io/v/DM-20378/stack/deprecating-interfaces.html#config-deprecation
            Hide
            ktl Kian-Tat Lim added a comment -

            Two minor grammatical suggestions, but looks great otherwise.

            Show
            ktl Kian-Tat Lim added a comment - Two minor grammatical suggestions, but looks great otherwise.
            Hide
            Parejkoj John Parejko added a comment -

            Kian-Tat Lim: did you have anything to add about the pex_config code changes?

            Show
            Parejkoj John Parejko added a comment - Kian-Tat Lim : did you have anything to add about the pex_config code changes?
            Hide
            ktl Kian-Tat Lim added a comment -

            No, everything looked fine there. (The test looked a little strange, but I think only because I haven't seen catch_warnings(record=True) before.)

            Show
            ktl Kian-Tat Lim added a comment - No, everything looked fine there. (The test looked a little strange, but I think only because I haven't seen catch_warnings(record=True) before.)
            Hide
            Parejkoj John Parejko added a comment -

            Thanks for the review. With Jonathan Sick's merging of DM-20448, the dev guide now properly links to the pipeline docs, too!

            Merged and done.

            Show
            Parejkoj John Parejko added a comment - Thanks for the review. With Jonathan Sick 's merging of DM-20448 , the dev guide now properly links to the pipeline docs, too! Merged and done.

              People

              • Assignee:
                Parejkoj John Parejko
                Reporter:
                Parejkoj John Parejko
                Reviewers:
                Kian-Tat Lim
                Watchers:
                John Parejko, John Swinbank, Kian-Tat Lim, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel