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

Convert afw.detection to numpydoc

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: afw
    • Labels:
    • Story Points:
      10
    • Epic Link:
    • Sprint:
      AP F20-6 (November), AP S21-1 (December)
    • Team:
      Alert Production

      Description

      Convert all Doxygen-formatted docstrings in afw.detection to Numpydoc style, and move corresponding topic documentation to doc/.

        Attachments

          Issue Links

          is blocked by

          Improvement - An improvement or enhancement to an existing feature or task. DM-16863 Convert afw.table to numpydoc

          • Done

            Activity

            Permalink
            kherner Kenneth Herner logged work - 09/Nov/20 7:27 PM
            • Time Spent:
              1 day, 4 hours
               

              Updated docstrings, removed doxygen-style sections, corrected formatting errors, enabled Python API section in Sphinx docs. Took longer than originally hoped owing to unfamiliarity with the setup, code base, and best practices.

              People

              Assignee:
              kherner Kenneth Herner
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Krzysztof Findeisen
              Watchers:
              Kenneth Herner, Krzysztof Findeisen, Yusra AlSayyad
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 4 hours
                  1d 4h

                    Jenkins

                    No builds found.