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

          No work has yet been logged on this issue.

            People

            Assignee:
            krughoff Simon Krughoff
            Reporter:
            jsick Jonathan Sick
            Reviewers:
            Jonathan Sick
            Watchers:
            John Parejko, Jonathan Sick, Krzysztof Findeisen, Simon Krughoff
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.