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

Fix docstring See also references in afw and ip_isr

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: afw, ip_isr
    • Labels:
      None

      Description

      While trialing Sphinx 3.2-based pipelines.lsst.io documentation builds, I found that a few See also docstring sections in afw and ip_isr were breaking the Sphinx builds, presumably due to more stringent requirements. The main issue is adding () to the function names; the See also section can only contain the actual API name.

        Attachments

          Issue Links

            Activity

            Show
            jsick Jonathan Sick added a comment - afw PR:  https://github.com/lsst/afw/pull/539 ip_isr PR:  https://github.com/lsst/ip_isr/pull/155

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  CI Builds

                  No builds found.