Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: afw
-
Labels:None
-
Epic Link:
-
Sprint:Science Pipelines DM-S15-2
-
Team:Data Release Production
Description
The Doxygen documentation for lsst::afw::image::wcs contains a number of minor mistakes and typos. Perhaps most egregiously, it repeatedly claims that functions called pixelToSky "convert from celestial coordinates to pixel coordinates". Further, a lot of documentation is duplicated, because it's included in both the header and the implementation (often in somewhat contradictory ways).
"Minor" doc fixes don't normally need tickets or review; since I'm changing quite a few lines at once here, I think it's worth filing and getting a second pair of eyes to check the changes.
Attachments
Activity
It all looks fine to me. I understand this is not meant to be a complete overhaul of the documentation, but while you're in there, it wouldn't hurt to impose further consistency in how variables, etc., are typed;
Examples:
RA vs. ra
Dec vs. dec
FITS vs. fits
WCS vs. Wcs
LSST vs. Lsst
DEC-TAN ==> DEC--TAN
e.g ==> e.g.
i.e ==> i.e.
Also, should the rotateImageBy90 function at line 149 in Wcs.h included a comment about which direction the image is rotated?
Thanks; made some further changes based on the above and committed. While most of those are just a matter of consistency, I think you're right that it is worth distinguishing between "WCS", an abbreviation for World Coordinate System, and Wcs, which is a class in our code. Plus DEC-TAN (& RA--TAN) are just wrong...
Hey Lauren, could you take a look at this? This is all fixes to documentation and comments, so it shouldn't break anything; I just want a sanity check before merging.
All tickets are on tickets/DM-2464 in afw.