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

Refresh & unify documentation on writing Tasks

    XMLWordPrintable

    Details

      Description

      Our current documentation on writing Tasks is fragmentary: it's partially in Doxygen and partially on Confluence. It's also incomplete – or, at least, it doesn't fully and unambiguously specify all the rules, procedures and best practices which developers are expected to bear in mind (see, for example, this discussion).

      Please provide a unified reference document on task construction, explicitly specifying all requirements.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-2639 Standardize primary method names, run/runDataRef, across PipeTasks

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-6640 IsrTask is not a valid CmdLineTask

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-6877 Please document the appropriate location for tasks

          • Won't Fix

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11673 Improve docs for creating Tasks (lsst.pipe.base docs)

          • Won't Fix

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11674 Improve docs for creating command-line tasks (lsst.pipe.base docs)

          • Won't Fix

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-5067 Port ‘How to document a task’ from DM Confluence

          • Invalid

          Improvement - An improvement or enhancement to an existing feature or task. DM-6075 Document the need for abstract base tasks for tasks

          • Done
          mentioned in

          Page Loading...

            Activity

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              swinbank John Swinbank
              Watchers:
              Jonathan Sick, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.