Details
-
Type:
Story
-
Status: Won't Fix
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pipe_tasks, Stack Documentation and UX
-
Labels:
-
Epic Link:
-
Team:SQuaRE
Description
On DM-6631, Russell Owen asserts:
Command-line tasks are encouraged to be in the package that makes most sense for them, so IsrTask belongs in ip_isr. pipe_tasks is intended for tasks (command-line and otherwise) that need so many packages that they don't make sense being in a lower-level package.
I certainly don't disagree – seems perfectly reasonable – but I've not seen it written down before. Please capture this in the developer documentation.
Attachments
Issue Links
Activity
Russell Owen: I think this is a ticket asking for the documentation to be improved. Am I misunderstanding your point?
I misread is as part of a different ticket.
Is this clarification still needed? Is it dev guide, pipelines.lsst.io, or pipe_task that should be updated? Is this now something for science pipelines to take on or still square?
It's clearly not a SQuaRE issue. Let's just close it.
John Swinbank I suggest you file a ticket asking for the documentation improvement. Existing documentation includes the task overview main.dox in pipe_base, "how to write a task" and "how to write a command-line task". There are surely others.