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

Convert obs_test to numpydoc

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: obs_test
    • Labels:

      Description

      Update all the python modules in the obs_test package so they have numpydoc doc strings instead of doxygen. Make sure the entire package sphinx docs can be built.

      Useful references: 
       
      https://community.lsst.org/t/pipelines-package-docs-hack-day-instructions/2742
      --> start at "Beginning the Numpydoc conversion, one module at a time"
       
      https://developer.lsst.io/python/numpydoc.html 

        Attachments

          Issue Links

            Activity

            Hide
            sullivan Ian Sullivan added a comment -

            Looks good. I had a few minor comments on the pull request.

            Show
            sullivan Ian Sullivan added a comment - Looks good. I had a few minor comments on the pull request.
            Hide
            rowen Russell Owen added a comment -

            Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

            Show
            rowen Russell Owen added a comment - Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

              People

              • Assignee:
                rowen Russell Owen
                Reporter:
                mrawls Meredith Rawls
                Watchers:
                Ian Sullivan, John Swinbank, Jonathan Sick, Meredith Rawls, Russell Owen
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel