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

improve docs for pex_config C++ wrapping

    XMLWordPrintable

    Details

    • Story Points:
      2
    • Team:
      Architecture

      Description

      We need a more complete example in the tutorial page for pex_config.

      • Should mention both wrap and makeControlClass
      • Should show how to actually use the new classes (i.e. call makeControl())
      • Nested control classes are now supported (contrary to current docs), but are perhaps use-at-own-risk (easy to get into Python circular import situations).

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-11558 pex_config numpydoc conversion and package documentation configuration

          • Done
          mentioned in

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            jbosch Jim Bosch created issue -
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Link to original conversation in #princeton. https://lsstc.slack.com/archives/C2JP8UD2L/p1507045259000030

            Show
            jsick Jonathan Sick added a comment - Link to original conversation in #princeton. https://lsstc.slack.com/archives/C2JP8UD2L/p1507045259000030
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Link This issue relates to DM-11558 [ DM-11558 ]
            swinbank John Swinbank made changes -
            Team Data Access and Database [ 10204 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 29306 ]
            Hide
            Permalink
            tjenness Tim Jenness added a comment -

            I assume this is still needed.

            Show
            tjenness Tim Jenness added a comment - I assume this is still needed.
            tjenness Tim Jenness made changes -
            Team Data Access and Database [ 10204 ] Architecture [ 10304 ]
            tjenness Tim Jenness made changes -
            Component/s pex_config [ 10729 ]
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            Yes, I believe we still have C++ control/config wrapping, but it's used very infrequently.

            Show
            ktl Kian-Tat Lim added a comment - Yes, I believe we still have C++ control/config wrapping, but it's used very infrequently.
            Parejkoj John Parejko made changes -
            Labels SciencePipelines documentation
            Parejkoj John Parejko made changes -
            Rank Ranked lower

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              jbosch Jim Bosch
              Watchers:
              Jim Bosch, John Parejko, Jonathan Sick, Kian-Tat Lim, Robert Lupton, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Dates

                Created:
                Updated:

                  Jenkins

                  No builds found.