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

Convert Task docstrings to Numpydoc and migrate Task documentation to reStructuredText

    Details

      Description

      This ticket coordinates the completion of the migration of Task docstrings and Task documentation in general to Numpydoc and reStructuredText. The conditions for the completion of this ticket are:

      1. All Task class docstrings are all migrated to Numpydoc
      2. All Tasks are documented in a Task topic type (to be defined in https://dmtn-030.lsst.io)
      3. Removal of the E266 PEP 8 code from setup.cfg files. The E266 ignore only exists to accommodate Doxygen-formatted Task docstrings.

        Attachments

          Issue Links

            Activity

            There are no comments yet on this issue.

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Jonathan Sick, Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel