Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pipe_tasks
-
Labels:
-
Story Points:6
-
Epic Link:
-
Sprint:AP F22-3 (August), AP F22-4 (September)
-
Team:Alert Production
-
Urgent?:No
Description
The work done on DM-15554 was done at least in part on DM-35670 by Eli Rykoff. We still need to make the task topic types and automodapi links, and there may be files/methods that were missed. Unfortunately, this means that rebasing DM-15554 onto main is going to be a lot of work, so we're probably off just starting from scratch.
This ticket is to run the doxygen->numpydoc converter (attached as `deDoxygen.py` on DM-14141) on pipe_tasks to cleanup whatever doxygen remains there, and get the doc/ directory correctly setup correctly.
It looks like Eli Rykoff removed the docs for lsstDebug parameters, so we should pull those back in to the task topic types; it may be that the .rst files created on DM-15554 already have everything, but I'll have to check that.
Attachments
Issue Links
- duplicates
-
DM-15554 Convert pipe_tasks to numpydoc status
- Invalid
- is triggering
-
DM-36182 cleanup and document functors.py
- To Do
-
DM-36249 Move task docs out of class docstrings
- To Do
-
DM-36250 Clean up "unknown" parameter and return type fields
- To Do
-
DM-36251 Cleanup pipelines.lsst.io pipe_tasks warnings due to pipe_tasks
- To Do
- relates to
-
DM-25882 Update docstrings to note lsstDebug options
- To Do
-
DM-35940 Cleanup return struct names
- To Do
-
DM-35670 Remove gen2 support from pipe_tasks
- Done
-
DM-37673 MakeWarpTask needs a task topic doc page
- Done
-
DM-14141 Automated helper for doxygen->numpydoc conversion
- To Do
-
DM-28969 Cleanup lsstDebug references in Task docs
- Done
-
DM-37165 CLONE - Cleanup lsstDebug references in Task docs
- Invalid