Document required entry points for Tasks

Description

Per https://rubinobs.atlassian.net/browse/RFC-352#icft=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).

Linked work items

is triggered by

RFC-352

Standardize the point of entry for all Tasks

Checklist

Lucidchart Diagrams

Issue Matrix

hide

Activity

Show:

John Swinbank

January 18, 2020 at 1:59 AM

Thanks! Merged and done.

Kian-Tat Lim

January 17, 2020 at 11:09 PM

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.

John Swinbank

January 16, 2020 at 1:36 AM

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 https://rubinobs.atlassian.net/browse/RFC-352#icft=RFC-352, so I think these minimal edits are worthwhile.

Resize issue view side panel

Done

Pinned fields

Click on the next to a field label to start pinning.

Details

Assignee

John Swinbank

Reporter

John Swinbank

Reviewers

Kian-Tat Lim

Story Points

RubinTeam

Alert Production

Components

pipe_base

Parent

DM-22484 Emergent work for AP in S20A

Priority

Undefined

Checklist

Created June 29, 2017 at 5:29 AM

Updated January 18, 2020 at 1:59 AM

Resolved January 18, 2020 at 1:59 AM