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

Add doc field to obs.base.FilterDefinition

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: obs_base
    • Labels:
      None

      Description

      As proposed in RFC-730, add an optional doc field to FilterDefinition that can be used to describe filters whose purpose is not obvious from their band or physical name. This change can be made independently of the other changes proposed on that RFC.

        Attachments

          Issue Links

            Activity

            No builds found.
            krzys Krzysztof Findeisen created issue -
            krzys Krzysztof Findeisen made changes -
            Field Original Value New Value
            Link This issue is triggered by RFC-730 [ RFC-730 ]
            krzys Krzysztof Findeisen made changes -
            Epic Link DM-26803 [ 439755 ]
            krzys Krzysztof Findeisen made changes -
            Team Alert Production [ 10300 ]
            Parejkoj John Parejko made changes -
            Assignee John Parejko [ parejkoj ]
            sullivan Ian Sullivan made changes -
            Sprint AP F20-7 (December) [ 1059 ]
            sullivan Ian Sullivan made changes -
            Sprint AP F20-7 (December) [ 1059 ] AP F20-6 (November) [ 1052 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked lower
            sullivan Ian Sullivan made changes -
            Sprint AP F20-6 (November) [ 1052 ] AP F20-7 (December) [ 1059 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked higher
            sullivan Ian Sullivan made changes -
            Rank Ranked lower
            sullivan Ian Sullivan made changes -
            Sprint AP S21-1 (December) [ 1059 ] AP S21-2 (January) [ 1064 ]
            sullivan Ian Sullivan made changes -
            Rank Ranked higher
            sullivan Ian Sullivan made changes -
            Epic Link DM-26803 [ 439755 ] DM-27911 [ 442604 ]
            Parejkoj John Parejko made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            Hide
            Parejkoj John Parejko added a comment -

            Tim Jenness: would you be willing to review this small change to obs_base, obs_decam, and obs_subaru? I only added doc fields for filters that I thought needed some description and that I could find notes online about.

            I think it would be useful to have similar information in obs_lsst's filters.py, possibly with links to the relevant design docs. I don't expect this doc field to be a catch-all, but having a sentence or two can help with questions like "Do I need to worry about what ENG-R1 is?"

            Show
            Parejkoj John Parejko added a comment - Tim Jenness : would you be willing to review this small change to obs_base, obs_decam, and obs_subaru? I only added doc fields for filters that I thought needed some description and that I could find notes online about. I think it would be useful to have similar information in obs_lsst's filters.py , possibly with links to the relevant design docs. I don't expect this doc field to be a catch-all, but having a sentence or two can help with questions like "Do I need to worry about what ENG-R1 is?"
            Parejkoj John Parejko made changes -
            Reviewers Tim Jenness [ tjenness ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Hide
            tjenness Tim Jenness added a comment -

            Looks okay. Minor comments only.

            Show
            tjenness Tim Jenness added a comment - Looks okay. Minor comments only.
            tjenness Tim Jenness made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            Show
            Parejkoj John Parejko added a comment - Jenkins: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/33456/pipeline
            Parejkoj John Parejko made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

              Assignee:
              Parejkoj John Parejko
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Tim Jenness
              Watchers:
              John Parejko, Krzysztof Findeisen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.