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

Move task docs out of class docstrings

    XMLWordPrintable

Details

    • No

    Description

      In order to move forward on the pipe_tasks doxygen->numpydoc conversion on DM-35939, I decided not to make the Task Topic RST files on that ticket. Some examples can be seen in mrawls's commits on DM-15554: cherry picking those commits might be a challenge given 4 years of repo churn, but we could at least copy/past the text and structure that Meredith wrote there.

      As part of this, we should convert the "Debugging" notes into links to the lsstDebug docs:
      https://pipelines.lsst.io/v/daily/modules/lsstDebug/index.html
      https://pipelines.lsst.io/v/daily/modules/lsst.pipe.base/creating-a-task.html#debug-variables

      This could be done as a mob coding exercise, with different people tackling different tasks, or with subtasks of this ticket.

      Attachments

        Issue Links

          Activity

            There are no comments yet on this issue.

            People

              Unassigned Unassigned
              Parejkoj John Parejko
              Ian Sullivan, John Parejko, Tim Jenness, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:

                Jenkins

                  No builds found.