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

Make pex_config generate reStructuredText-compatible docstrings

    XMLWordPrintable

Details

    Description

      We discovered that pexConfig objects create _doc_ (docstring) attributes automatically based on information passed to configuration constructors. This means that configuration fields are documented in the attributes of configuration classes inside the regular API documentation.

      This is great, but can also fail if the automatically-generated config field docstring is not reStructuredText/Numpydoc compatible.

      This ticket is to change the _doc_ generators of pexConfig fields so that they output Numpydoc/reStructuredText docstrings.

      Attachments

        Activity

          I created the PR before I knew what the ticket was.  It is: https://github.com/lsst/pex_config/pull/21.  Let me know if you want me to make it show up in the side pane.  I'll also trigger a build.

          krughoff Simon Krughoff (Inactive) added a comment - I created the PR before I knew what the ticket was.  It is: https://github.com/lsst/pex_config/pull/21 .  Let me know if you want me to make it show up in the side pane.  I'll also trigger a build.
          krughoff Simon Krughoff (Inactive) added a comment - - edited

          Merge run here.

          krughoff Simon Krughoff (Inactive) added a comment - - edited Merge run here .
          Parejkoj John Parejko added a comment -

          Your PR link above doesn't appear to be correct (it's a dead link on github). Where is the branch and PR for this?

          Parejkoj John Parejko added a comment - Your PR link above doesn't appear to be correct (it's a dead link on github). Where is the branch and PR for this?

          How about this?

          krughoff Simon Krughoff (Inactive) added a comment - How about this ?
          Parejkoj John Parejko added a comment -

          That's better, thanks. Please add the ticket number to the PR description, per the dev guide. Particularly important since the branch has a different name.

          https://developer.lsst.io/processes/workflow.html#make-a-pull-request

          Parejkoj John Parejko added a comment - That's better, thanks. Please add the ticket number to the PR description, per the dev guide. Particularly important since the branch has a different name. https://developer.lsst.io/processes/workflow.html#make-a-pull-request
          krughoff Simon Krughoff (Inactive) added a comment - - edited

          As I mentioned above I created the PR before I knew the ticket. I offered to move the branch. I can rename it.

          I didn't think it was a huge deal since there is only one PR on pex_config right now.

          krughoff Simon Krughoff (Inactive) added a comment - - edited As I mentioned above I created the PR before I knew the ticket. I offered to move the branch. I can rename it. I didn't think it was a huge deal since there is only one PR on pex_config right now.
          Parejkoj John Parejko added a comment -

          I know: unless someone strongly objects (tjenness?) don't rename the branch since that will close the PR (branch moves are really "create new, delete old").

          Parejkoj John Parejko added a comment - I know: unless someone strongly objects ( tjenness ?) don't rename the branch since that will close the PR (branch moves are really "create new, delete old").

          People

            krughoff Simon Krughoff (Inactive)
            jsick Jonathan Sick
            Jonathan Sick
            John Parejko, Jonathan Sick, Krzysztof Findeisen, Simon Krughoff (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.