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

Convert shapelet documentation to numpydoc and remove Python 2 compatibility

    Details

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

      Attachments

        Issue Links

          Activity

          swinbank John Swinbank created issue -
          swinbank John Swinbank made changes -
          Field Original Value New Value
          Epic Link DM-14447 [ 80385 ]
          swinbank John Swinbank made changes -
          Risk Score 0
          gkovacs Gabor Kovacs made changes -
          Assignee Gabor Kovacs [ gkovacs ]
          gkovacs Gabor Kovacs made changes -
          Attachment sphinx_build.log [ 34256 ]
          Attachment sphinx_error_traceback.log [ 34257 ]
          Hide
          gkovacs Gabor Kovacs added a comment - - edited

          As of this commit the existing python docs is now formally converted to numpydoc format. Notes:

          • The documentation has a number of holes. The general description and usage information are missing and existing docstrings can be improved, too.
          • The python package supports both Python 2 and 3. However, imports from builtin caused sphinx build crashes as it followed these symbol names (imports from __future__ seems to cause no problem). sphinx_build.log sphinx_error_traceback.log
          • Added __all__ to hide these in the affected source file.
          • EllipseCore is a typedef alias in the cc code of lsst::afw::geom::ellipses::Quadrupole. I don't think it appears anywhere in the Python namespace, removed this alias import as it also causes sphinx problems.

          As discussed, I'll now remove the Python 2 compatibility stuff to complete this ticket.

          Show
          gkovacs Gabor Kovacs added a comment - - edited As of this commit the existing python docs is now formally converted to numpydoc format. Notes: The documentation has a number of holes. The general description and usage information are missing and existing docstrings can be improved, too. The python package supports both Python 2 and 3. However, imports from builtin caused sphinx build crashes as it followed these symbol names (imports from __ future __ seems to cause no problem). sphinx_build.log sphinx_error_traceback.log Added __ all __ to hide these in the affected source file. EllipseCore is a typedef alias in the cc code of lsst::afw::geom::ellipses::Quadrupole. I don't think it appears anywhere in the Python namespace, removed this alias import as it also causes sphinx problems. As discussed, I'll now remove the Python 2 compatibility stuff to complete this ticket.
          gkovacs Gabor Kovacs made changes -
          Status To Do [ 10001 ] In Progress [ 3 ]
          gkovacs Gabor Kovacs made changes -
          Summary Convert shapelet documentation to numpydoc Convert shapelet documentation to numpydoc and remove Python 2 compatibility
          Hide
          gkovacs Gabor Kovacs added a comment - - edited

          Removed Python 2 compatibility here.

          Show
          gkovacs Gabor Kovacs added a comment - - edited Removed Python 2 compatibility here.
          swinbank John Swinbank made changes -
          Remote Link This issue links to "Page (Confluence)" [ 17998 ]
          gkovacs Gabor Kovacs made changes -
          Reviewers Tim Jenness [ tjenness ]
          Status In Progress [ 3 ] In Review [ 10004 ]
          Hide
          tjenness Tim Jenness added a comment -

          Looks good. Some very minor comments on the PR.

          Show
          tjenness Tim Jenness added a comment - Looks good. Some very minor comments on the PR.
          tjenness Tim Jenness made changes -
          Status In Review [ 10004 ] Reviewed [ 10101 ]
          Hide
          gkovacs Gabor Kovacs added a comment -

          Comments applied, commits rebased and squashed.

          Show
          gkovacs Gabor Kovacs added a comment - Comments applied, commits rebased and squashed.
          gkovacs Gabor Kovacs made changes -
          Resolution Done [ 10000 ]
          Status Reviewed [ 10101 ] Done [ 10002 ]

            People

            • Assignee:
              gkovacs Gabor Kovacs
              Reporter:
              swinbank John Swinbank
              Reviewers:
              Tim Jenness
              Watchers:
              Gabor Kovacs, John Swinbank, Tim Jenness
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Summary Panel