Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pex_config, Stack Documentation and UX
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Team:SQuaRE
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
Merge run here.
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?
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
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.
I know: unless someone strongly objects (Tim Jenness?) don't rename the branch since that will close the PR (branch moves are really "create new, delete old").
Merged.
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.