Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: pipelines_lsst_io
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Team:SQuaRE
Description
These packages have doc/ directories that don't fit the current standards (mostly because they include package documention when they really only should have module documentation). This ticket is to fix these packages:
- afw
- base
- coadd_utils
- daf_butler
- display_ds9
- ip_diffim
- ip_isr
- jointcal
- log
- meas_algorithms
- meas_deblender
- meas_extensions_photometryKron
- meas_extensions_shapeHSM
- meas_extensions_simpleShape
- meas_modelfit
- obs_base
- obs_cfht
- obs_lsstSim
- obs_test
- pex_exceptions
- pipe_base
- pipe_drivers
- shapelet
- utils
- validate_drp
- verify
Also, there's a typo in the title of the lsst.meas.extensions.simpleShape module docs.
Attachments
Activity
Just to be clear — do any of those package documentation files contain useful content? If so, presumably you'll have to do something with that in addition to the changes you suggest above (although maybe that just means moving it to the module's index.rst).
That said: I think it's fine to self-merge as you suggest. If you do hit any significant content that needs a second pair of eyeballs, ping it my way and I'll look as a priority.
Thanks, I don't they do, but I'll ping you.
All listed packages got updated before the w.2019.06 tag landed. Combined with DM-17765, which makes package inclusion in pipelines.lsst.io more explicit through the table file, the module listing in pipelines.lsst.io is in good shape for the 17.0 release.
John Swinbank: I'd like to get this ticket done so that the pipelines.lsst.io docs look tidy-ish for the 17.0 release. If the next weekly is to be taken as the basis of the 17.0 release, that means the doc/ directories we have will be the ones in the 17.0 release. So time is tight, but I can probably make a merge PRs for all these packages in the next few hours before the weekly is tagged. The question is, can I get an exception to self-merge these since the only things I'll be touching are doc/manifest.yaml and index.rst files.