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

Document pybind11 tools

    Details

    • Templates:
    • Story Points:
      4
    • Epic Link:
    • Team:
      Data Release Production

      Description

      We've developed a number of tools, mostly in utils, for performing common pybind11 wrappings. At the moment, these tools are rather difficult for new developers to find.

      I propose we draw attention to pybind11 wrapping tools in the Developer Guide. Two possible ways of doing this:

      • Add a new Developer Guide section, parallel to "DM Pybind11 Style Guide" and "Python wrappers for C++ with pybind11", with links to the tools' API documentation (prone to bit rot?).
      • Add a link to the top of "Python wrappers for C++ with pybind11" that points to an API docs search query (a single clean query may not be possible).

      I am only aware of the tools in lsst::utils::python, but there may be others. Tracking down a complete list of pybind11 tools should be considered within the scope of this ticket.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                krzys Krzysztof Findeisen
                Watchers:
                John Swinbank, Jonathan Sick, Krzysztof Findeisen
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Summary Panel