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

Document required entry points for Tasks

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: pipe_base
    • Labels:
      None

      Description

      Per RFC-352, all Task​s (modulo approved exceptions; see the RFC for details) are expected to provide a run method as their primary point of entry, and may also provide runDataRef for operating on dataRefs. Please update the documentation in pipe_base to explain this requirement (and the procedure for obtaining an exemption).

        Attachments

          Issue Links

            Activity

            Hide
            swinbank John Swinbank added a comment -

            Hey Kian-Tat Lim, could you please give https://github.com/lsst/pipe_base/pull/113 a quick review?

            I'm unsure of how much of this documentation remains valid in the world of PipelineTask, and I note that this whole page has a big “needs to be edited” disclaimer on the top, so I'm not keen to spend significant effort on this. However, the existing text was causing confusion and encouraging the rule as per RFC-352, so I think these minimal edits are worthwhile.

            Show
            swinbank John Swinbank added a comment - Hey Kian-Tat Lim , could you please give https://github.com/lsst/pipe_base/pull/113 a quick review? I'm unsure of how much of this documentation remains valid in the world of PipelineTask, and I note that this whole page has a big “needs to be edited” disclaimer on the top, so I'm not keen to spend significant effort on this. However, the existing text was causing confusion and encouraging the rule as per RFC-352 , so I think these minimal edits are worthwhile.
            Hide
            ktl Kian-Tat Lim added a comment -

            I see the "needs to be edited" as more about style than substance, and much of this should still be useful with PipelineTask.

            It's kind of a shame that the very first example contradicts (with good reason) the newly-documented rule, but the additional text and reorganization looks great to me.

            Show
            ktl Kian-Tat Lim added a comment - I see the "needs to be edited" as more about style than substance, and much of this should still be useful with PipelineTask. It's kind of a shame that the very first example contradicts (with good reason) the newly-documented rule, but the additional text and reorganization looks great to me.
            Hide
            swinbank John Swinbank added a comment -

            Thanks! Merged and done.

            Show
            swinbank John Swinbank added a comment - Thanks! Merged and done.

              People

              • Assignee:
                swinbank John Swinbank
                Reporter:
                swinbank John Swinbank
                Reviewers:
                Kian-Tat Lim
                Watchers:
                John Swinbank, Kian-Tat Lim
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel