Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: obs_base
-
Labels:None
-
Story Points:2
-
Epic Link:
-
Sprint:AP S21-2 (January)
-
Team:Alert Production
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
- is triggered by
-
RFC-730 Replace afw.image.Filter with simple label-based classes
- Implemented
Activity
Looks okay. Minor comments only.
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?"