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

Convert shapelet documentation to numpydoc and remove Python 2 compatibility

    XMLWordPrintable

    Details

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

      Attachments

      1. sphinx_build.log
        5 kB
        Gabor Kovacs [X]
      2. sphinx_error_traceback.log
        7 kB
        Gabor Kovacs [X]

        Issue Links

        mentioned in

        Page Loading...

          Activity

          Ascending order - Click to sort in descending order
          Hide
          Permalink
          gkovacs Gabor Kovacs [X] (Inactive) 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 [X] (Inactive) 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.
          Hide
          Permalink
          gkovacs Gabor Kovacs [X] (Inactive) added a comment - - edited

          Removed Python 2 compatibility here.

          Show
          gkovacs Gabor Kovacs [X] (Inactive) added a comment - - edited Removed Python 2 compatibility here.
          Hide
          Permalink
          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.
          Hide
          Permalink
          gkovacs Gabor Kovacs [X] (Inactive) added a comment -

          Comments applied, commits rebased and squashed.

          Show
          gkovacs Gabor Kovacs [X] (Inactive) added a comment - Comments applied, commits rebased and squashed.

            People

            Assignee:
            gkovacs Gabor Kovacs [X] (Inactive)
            Reporter:
            swinbank John Swinbank
            Reviewers:
            Tim Jenness
            Watchers:
            Gabor Kovacs [X] (Inactive), John Swinbank, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.