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

            Activity

            Hide
            kherner Kenneth Herner added a comment -

            Thanks, I'll go through them in detail to get what was missed.

            Show
            kherner Kenneth Herner added a comment - Thanks, I'll go through them in detail to get what was missed.
            Hide
            kherner Kenneth Herner added a comment -

            Krzysztof, are you free to review these changes for DM-16857? A pull request is in and the Jenkins run is here:

            https://ci.lsst.codes/job/stack-os-matrix/33164/display/redirect

            Show
            kherner Kenneth Herner added a comment - Krzysztof, are you free to review these changes for DM-16857 ? A pull request is in and the Jenkins run is here: https://ci.lsst.codes/job/stack-os-matrix/33164/display/redirect
            Hide
            krzys Krzysztof Findeisen added a comment -

            Looks much better, though the topic page for detection is still inside Doxygen. I give an example of how it could be moved to Sphinx, though I think this particular page could simply be deleted with no loss of information. Happy to re-review once either is done.

            Show
            krzys Krzysztof Findeisen added a comment - Looks much better, though the topic page for detection is still inside Doxygen. I give an example of how it could be moved to Sphinx, though I think this particular page could simply be deleted with no loss of information. Happy to re-review once either is done.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Revised version looks good!

            Show
            krzys Krzysztof Findeisen added a comment - Revised version looks good!
            Hide
            kherner Kenneth Herner added a comment -

            Did a final build check (passed) and merged to master just now. That should do the trick.

            Show
            kherner Kenneth Herner added a comment - Did a final build check (passed) and merged to master just now. That should do the trick.

              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 Builds

                    No builds found.