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

Please document the appropriate location for tasks

    XMLWordPrintable

Details

    Description

      On DM-6631, rowen 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

            rowen Russell Owen added a comment -

            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.

            rowen Russell Owen added a comment - 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.

            rowen: I think this is a ticket asking for the documentation to be improved. Am I misunderstanding your point?

            swinbank John Swinbank added a comment - rowen : 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.

            rowen Russell Owen added a comment - I misread is as part of a different ticket.
            tjenness Tim Jenness added a comment -

            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?

            tjenness Tim Jenness added a comment - 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.

            swinbank John Swinbank added a comment - It's clearly not a SQuaRE issue. Let's just close it.

            People

              jsick Jonathan Sick
              swinbank John Swinbank
              John Swinbank, Russell Owen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.