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

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

    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

            Activity

            Hide
            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."

              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:

                  Summary Panel