Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: None
-
Labels:
-
Story Points:2
-
Epic Link:
-
Sprint:AP S18-5
-
Team:Alert Production
Description
After some discussion with Jonathan Sick, we agreed it's probably easiest for us to just do the sphinx setup for all the packages ourselves (it takes me longer to teach someone how to do a package than to just do it; SublimeText makes the file editing very fast). I'll tackle as many as I can now, and leave the rest for Jonathan Sick. I'll track the ones I'm doing on the confluence page:
https://confluence.lsstcorp.org/pages/viewpage.action?pageId=73573930
I won't do anything with any packages that are already claimed on there: someone will have to bug folks to merge what they've got, if they haven't already.
Note that this won't entail any actual numpydoc conversion: that is left for others.
Attachments
Issue Links
Activity
Jonathan Sick: I'm doing namespace curation if it's trivial (e.g. pex_exceptions).
pex_policy is going to need namespace curation at the pybind11 level, I think, while log uses continueClass and lifts a lot of static methods into global namespace intentionally, so it'll require some thought.
Jonathan Sick I fixed the problems you reported with the first chunk of packages, and I've done a handful more (incorporating the link fix into my script, now uploaded). Could you please review the remaining packages, and answer my question at afw PR 337 so I can fix it?
I believe these are the ones that remain:
https://github.com/lsst/pipe_drivers/pull/55
https://github.com/lsst/obs_cfht/pull/44
https://github.com/lsst/obs_sdss/pull/49
https://github.com/lsst/obs_lsstSim/pull/63
https://github.com/lsst/coadd_chisquared/pull/12
https://github.com/lsst/meas_modelfit/pull/52
I tried to fix the handful of numpydoc errors in obs_cfht, but I'm still getting this error. Suggestions?
/Users/parejkoj/lsst/lsstsw3/build/obs_cfht/python/lsst/obs/cfht/megacamMapper.py:docstring of lsst.obs.cfht.MegacamMapper:6: WARNING: Inline emphasis start-string without end-string.
|
/Users/parejkoj/lsst/lsstsw3/build/obs_cfht/python/lsst/obs/cfht/cfhtIsrTask.py:docstring of lsst.obs.cfht.cfhtIsrTask.CfhtIsrTask:2: WARNING: Inline emphasis start-string without end-string.
|
/Users/parejkoj/lsst/lsstsw3/build/obs_cfht/python/lsst/obs/cfht/cfhtIsrTask.py:docstring of lsst.obs.cfht.cfhtIsrTask.CfhtIsrTask:2: WARNING: Inline strong start-string without end-string.
|
I think I'm going to call it quits with this.
Thanks John Parejko, I see the new PRs and I’ll process them today.
I’ll figure out your obs_cfht questions when I get into that package. Alas, the error reporting isn’t totally useful right now :/
Jonathan Sick Thanks for the comments so far. I've merged everything that had a clean review. If you could offer suggestions on how to fix obs_cfht, and re-check the packages that I updated but haven't yet merged, I'd be much obliged.
Thanks for doing this. It looks good to go.
There are Numpydoc warnings in obs_cfht, but I think they're all coming from base classes (https://github.com/lsst/obs_base). To do things totally right we'll have to fix up obs_base first. But at this stage, I'm totally okay with merging this as-is.
jenkins run before I merge the rest: https://ci.lsst.codes/blue/organizations/jenkins/stack-os-matrix/detail/stack-os-matrix/27824/pipeline
Thanks for the review. The script I attached made this really easy, if you want to use it to finish off the rest of the packages.
It looks like mostly what remains are the ctrl packages, plus a handful of meas.
Jira doesn't seem to believe that meas_modelfit was merged, but it really was, I promise.
Attached a bash script that makes the job even easier.