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

Improve docs for creating command-line tasks (lsst.pipe.base docs)

    XMLWordPrintable

    Details

      Description

      DM-11253 ported docs on how to create a command-line task from Doxygen to reStructuredText. This generated a number of comments in the PR https://github.com/lsst/pipe_base/pull/37

      In this ticket:

      • Address those PR comments
      • Generally improve the topic (refactor into topic-based writing, for example).

        Attachments

          Issue Links

          is triggered by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11253 Initial Sphinx docs for pipe_base

          • Done
          relates to

          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

          Improvement - An improvement or enhancement to an existing feature or task. DM-11730 Clarify Tasks' error-handling behavior

          • To Do

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-6648 Refresh & unify documentation on writing Tasks

          • Won't Fix

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-5646 [ 23496 ]
            jsick Jonathan Sick made changes -
            Link This issue is triggered by DM-11253 [ DM-11253 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11673 [ DM-11673 ]
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            DM-11673 covers refactoring documentation for creating a new task; this is related documentation to cover command-line tasks specifically.

            Show
            jsick Jonathan Sick added a comment - DM-11673 covers refactoring documentation for creating a new task; this is related documentation to cover command-line tasks specifically.
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-6648 [ DM-6648 ]
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Comments on the existing document: https://github.com/lsst/pipe_base/pull/37/files#diff-afb70dbd7b37e15ec4ff6c41991730e8

            Show
            jsick Jonathan Sick added a comment - Comments on the existing document: https://github.com/lsst/pipe_base/pull/37/files#diff-afb70dbd7b37e15ec4ff6c41991730e8
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11730 [ DM-11730 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Won't Fix [ 10405 ]

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.