Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: afw
-
Labels:
-
Story Points:10
-
Epic Link:
-
Sprint:AP F20-6 (November), AP S21-1 (December)
-
Team:Alert Production
Description
Convert all Doxygen-formatted docstrings in afw.detection to Numpydoc style, and move corresponding topic documentation to doc/.
Attachments
Issue Links
- is blocked by
-
- Done
Activity
Krzysztof Findeisen
created issue -
Krzysztof Findeisen
made changes -
| Field | Original Value | New Value |
|---|---|---|
| Epic Link |
|
Krzysztof Findeisen
made changes -
| Story Points | 1 |
Krzysztof Findeisen
made changes -
| Assignee | Krzysztof Findeisen [ krzys ] |
Krzysztof Findeisen
made changes -
| Story Points | 1 |
Krzysztof Findeisen
made changes -
| Resolution | Done [ 10000 ] | |
| Status | To Do [ 10001 ] | Invalid [ 11005 ] |
Turns out the documentation wasn't actually being displayed. Re-opening.
Krzysztof Findeisen
added a comment - Turns out the documentation wasn't actually being displayed. Re-opening. Krzysztof Findeisen
made changes -
| Resolution | Done [ 10000 ] | |
| Status | Invalid [ 11005 ] | In Progress [ 3 ] |
Krzysztof Findeisen
made changes -
Krzysztof Findeisen
made changes -
| Status | In Progress [ 3 ] | To Do [ 10001 ] |
Documentation cannot currently be built; I think the errors will go away once afw.table is numpydoc-compatible.
Krzysztof Findeisen
added a comment - Documentation cannot currently be built; I think the errors will go away once afw.table is numpydoc-compatible. Krzysztof Findeisen
made changes -
| Assignee | Krzysztof Findeisen [ krzys ] |
Krzysztof Findeisen
made changes -
| Sprint | AP S19-1 [ 825 ] |
| Assignee | Kenneth Herner [ kherner ] |
| Sprint | AP F20-6 (November) [ 1052 ] |
Ian Sullivan, Eric Bellm, Krzysztof Findeisen Looks like this ticket has evolved from the original description. What needs to be done now?
The Sphinx documentation for lsst.afw.detection still isn't activated (see https://pipelines.lsst.io/v/daily/modules/lsst.afw.detection/index.html, which doesn't have any of the Python API). The topic page is also still in Doxygen (https://github.com/lsst/afw/blob/master/doc/mainpage.dox#L284).
In addition, while the Python docstrings have been converted from Doxygen-style (https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/multiband.py), some of them can't really be called Numpydoc-style (https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/_footprintMerge.py).
So I think the original description still stands.
Krzysztof Findeisen
added a comment - - edited The Sphinx documentation for lsst.afw.detection still isn't activated (see https://pipelines.lsst.io/v/daily/modules/lsst.afw.detection/index.html , which doesn't have any of the Python API). The topic page is also still in Doxygen ( https://github.com/lsst/afw/blob/master/doc/mainpage.dox#L284 ).
In addition, while the Python docstrings have been converted from Doxygen-style ( https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/multiband.py ), some of them can't really be called Numpydoc-style ( https://github.com/lsst/afw/blob/master/python/lsst/afw/detection/_footprintMerge.py ).
So I think the original description still stands. 
Kenneth Herner
logged work - 09/Nov/20 7:27 PM -
- Time Spent:
- 1 day, 4 hours
-
Updated docstrings, removed doxygen-style sections, corrected formatting errors, enabled Python API section in Sphinx docs. Took longer than originally hoped owing to unfamiliarity with the setup, code base, and best practices.
Thanks, I'll go through them in detail to get what was missed.
Kenneth Herner
added a comment - Thanks, I'll go through them in detail to get what was missed. Kenneth Herner
made changes -
| Status | To Do [ 10001 ] | In Progress [ 3 ] |
Krzysztof, are you free to review these changes for DM-16857? A pull request is in and the Jenkins run is here:
https://ci.lsst.codes/job/stack-os-matrix/33164/display/redirect
Kenneth Herner
added a comment - Krzysztof, are you free to review these changes for DM-16857 ? A pull request is in and the Jenkins run is here:
https://ci.lsst.codes/job/stack-os-matrix/33164/display/redirect Kenneth Herner
made changes -
| Reviewers | Krzysztof Findeisen [ krzys ] | |
| Status | In Progress [ 3 ] | In Review [ 10004 ] |
| Sprint | AP F20-6 (November) [ 1052 ] | AP F20-6 (November), AP S21-1 (December) [ 1052, 1059 ] |
Kenneth Herner
made changes -
| Attachment | build_DM-16857_2020-12-01.tar.gz [ 46492 ] |
Krzysztof Findeisen
made changes -
| Status | In Review [ 10004 ] | In Progress [ 3 ] |
Looks much better, though the topic page for detection is still inside Doxygen. I give an example of how it could be moved to Sphinx, though I think this particular page could simply be deleted with no loss of information. Happy to re-review once either is done.
Krzysztof Findeisen
added a comment - Looks much better, though the topic page for detection is still inside Doxygen. I give an example of how it could be moved to Sphinx, though I think this particular page could simply be deleted with no loss of information. Happy to re-review once either is done. Krzysztof Findeisen
made changes -
| Status | In Progress [ 3 ] | In Review [ 10004 ] |
Revised version looks good!
Krzysztof Findeisen
added a comment - Revised version looks good! Krzysztof Findeisen
made changes -
| Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
Kenneth Herner
made changes -
| Worklog Id | 30604 [ 30604 ] | |
| Remaining Estimate | 0 minutes [ 0 ] | |
| Time Spent | 1 day, 4 hours [ 43200 ] |
Did a final build check (passed) and merged to master just now. That should do the trick.
Kenneth Herner
added a comment - Did a final build check (passed) and merged to master just now. That should do the trick. Kenneth Herner
made changes -
| Resolution | Done [ 10000 ] | |
| Status | Reviewed [ 10101 ] | Done [ 10002 ] |
| Epic Link |
|
PREOPS-124 [ 441054 ] |
| Story Points | 1 | 6 |
| Story Points | 6 | 10 |
afw.detection has already been converted.