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

Convert Task docstrings to Numpydoc and migrate Task documentation to reStructuredText

    XMLWordPrintable

    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

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-16824 Convert meas_algorithms to numpydoc format

          • Done
          links to

          Web Link Slack conversation about E266

            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-12790 [ 36408 ]
            jsick Jonathan Sick made changes -
            Risk Score 0
            jsick Jonathan Sick made changes -
            Remote Link This issue links to "Slack conversation about E266 (Web Link)" [ 16869 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-12790 [ 36408 ] DM-14522 [ 86285 ]
            jsick Jonathan Sick made changes -
            Epic Link DM-14522 [ 86285 ] DM-5646 [ 23496 ]
            Parejkoj John Parejko made changes -
            Link This issue relates to DM-16824 [ DM-16824 ]
            Parejkoj John Parejko made changes -
            Urgent? off
            jsick Jonathan Sick made changes -
            Epic Link DM-5646 [ 23496 ] DM-30576 [ 511565 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Invalid [ 11005 ]
            frossie Frossie Economou made changes -
            Epic Link DM-30576 [ 511565 ] DM-30577 [ 511566 ]

              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:
                Resolved:

                  Jenkins

                  No builds found.