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

Pythonic type names in pybind11 docstrings

    Details

    • Type: Story
    • Status: To Do
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: None

      Description

      While wrapping pipe_tasks for pybind11, I found a cosmetic bug in which a method's docstring reported some parameter types in C++ style and others in python style:

      1. (self: lsst.meas.base._sdssCentroid.SdssCentroidTransform, inputCatalog: lsst.afw.table._source.SourceCatalog, outputCatalog: lsst.afw.table._base.BaseCatalog, wcs: lsst::afw::image::Wcs, calib: lsst::afw::image::Calib) -> None

      The problem was fixed by importing Wcs and Calib before importing the pybind11 wrapper, but I've since seen the same problem in other methods. We should audit the pybind11 wrappers to ensure that their types are always reported in python terms.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                krzys Krzysztof Findeisen
                Watchers:
                Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel