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

            Activity

            swinbank John Swinbank created issue -
            swinbank John Swinbank made changes -
            Field Original Value New Value
            Link This issue relates to DM-6075 [ DM-6075 ]
            swinbank John Swinbank made changes -
            Link This issue relates to DM-5067 [ DM-5067 ]
            swinbank John Swinbank made changes -
            Assignee Jonathan Sick [ jsick ]
            swinbank John Swinbank made changes -
            Description Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5].

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            swinbank John Swinbank made changes -
            Link This issue relates to DM-2639 [ DM-2639 ]
            swinbank John Swinbank made changes -
            Link This issue relates to DM-6640 [ DM-6640 ]
            jsick Jonathan Sick made changes -
            Assignee Jonathan Sick [ jsick ]
            jsick Jonathan Sick made changes -
            Epic Link DM-6199 [ 24715 ]
            swinbank John Swinbank made changes -
            Description Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            swinbank John Swinbank made changes -
            Description Our current documentation on writing tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            Our current documentation on writing Tasks is fragmentary: it's partially in [Doxygen|https://lsst-web.ncsa.illinois.edu/doxygen/x_masterDoxyDoc/pipe_tasks_write_task.html] and partially on [Confluence|https://confluence.lsstcorp.org/display/DM/How+to+document+a+Task]. 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|https://community.lsst.org/t/task-api-changes-involving-dataids-butlers/881/5]).

            Please provide a unified reference document on task construction, explicitly specifying all requirements.
            swinbank John Swinbank made changes -
            Summary Refresh and update documentation on writing Tasks Refresh & unify documentation on writing Tasks
            jsick Jonathan Sick made changes -
            Labels pipelines-docs
            swinbank John Swinbank made changes -
            Link This issue relates to DM-6877 [ DM-6877 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-6199 [ 24715 ] DM-5646 [ 23496 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11673 [ DM-11673 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11674 [ DM-11674 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 28631 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Won't Fix [ 10405 ]

              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.