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

Improve docs for creating Tasks (lsst.pipe.base docs)

    XMLWordPrintable

    Details

      Description

      DM-11253 ported docs on how to create a 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

          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

          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

            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-11674 [ DM-11674 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-6648 [ DM-6648 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11730 [ DM-11730 ]
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            Something I noted in passing: "Supply useful defaults for all config parameters if at all possible. Your task will be much easier to use if the default configuration usually suffices." should be enhanced with "If you can't think of a useful default for a config parameter, it is likely better off being an input parameter instead."

            Show
            ktl Kian-Tat Lim added a comment - Something I noted in passing: "Supply useful defaults for all config parameters if at all possible. Your task will be much easier to use if the default configuration usually suffices." should be enhanced with "If you can't think of a useful default for a config parameter, it is likely better off being an input parameter instead."
            ktl Kian-Tat Lim made changes -
            Risk Score 0
            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, Kian-Tat Lim
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.