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

Convert afw.cameraGeom to numpydoc

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: afw
    • Labels:
    • Story Points:
      1
    • Sprint:
      AP S19-1, AP S19-2
    • Team:
      Alert Production

      Description

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

        Attachments

          Activity

          Show
          Parejkoj John Parejko added a comment - Jenkins run: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/29185/pipeline
          Hide
          Parejkoj John Parejko added a comment -

          Russell Owen: Thanks for volunteering.

          The commits are atomic; you probably want to look at them separately.

          Show
          Parejkoj John Parejko added a comment - Russell Owen : Thanks for volunteering. The commits are atomic; you probably want to look at them separately.
          Hide
          rowen Russell Owen added a comment - - edited

          Pull request: https://github.com/lsst/afw/pull/426

          I took a first pass and requested some changes.

          Show
          rowen Russell Owen added a comment - - edited Pull request: https://github.com/lsst/afw/pull/426 I took a first pass and requested some changes.
          Hide
          Parejkoj John Parejko added a comment -

          Russell Owen: I've cleaned up per your comments and converted the `cameraGeom.dox` file to .rst and fixed its links. Anything else?

          Show
          Parejkoj John Parejko added a comment - Russell Owen : I've cleaned up per your comments and converted the `cameraGeom.dox` file to .rst and fixed its links. Anything else?
          Hide
          rowen Russell Owen added a comment -

          Looks great! Just a few small requested changes on github (most notably, please make the class names links in the new .rst file)

          Show
          rowen Russell Owen added a comment - Looks great! Just a few small requested changes on github (most notably, please make the class names links in the new .rst file)
          Show
          Parejkoj John Parejko added a comment - Thanks for the review! New Jenkins run: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/29251/pipeline
          Hide
          Parejkoj John Parejko added a comment -

          Merged and done.

          Show
          Parejkoj John Parejko added a comment - Merged and done.

            People

            • Assignee:
              Parejkoj John Parejko
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Russell Owen
              Watchers:
              John Parejko, Krzysztof Findeisen, Russell Owen
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel