Details
-
Type:
Bug
-
Status: Invalid
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:None
-
Story Points:1
-
Team:Alert Production
Description
There are a few (several?) tasks under pipe_tasks where the sphinx automodapi directive is not called, just lsst-task-api-summary.
This results in an uninformatively short excerpt of the docstrings in the documentation and most of the information written in the code docstrings is actually skipped. Also, there is no link generated with the class name, not even to the "Python API summary" page.
As of writing, this is the case with e.g. ScaleZeroPointTask or ProcessCcdTask. For me, it seems that there was once a generic documentation template file for pipe_tasks which was manually modified in a few cases only.
Counterexamples are assembleCoadd and dcrAssembleCoadd that have their automodapi directive explicitly in the top level pipe_tasks index.rst.
This issue may be connected to the (lack of) numpydoc migration of docstrings.
- Make a decision where the automodapi directive should go.
- Update the documentation of each task under pipe_tasks in a consistent way.
Attachments
Issue Links
- duplicates
-
DM-15554 Convert pipe_tasks to numpydoc status
- Invalid