DM-14557: Add package docs to datasets #35
Conversation
| @@ -14,7 +14,7 @@ Repository | |||
| https://github.com/lsst-dm/ap_verify | |||
|
|
|||
| Jira component | |||
| `ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM AND component %3D ap_verify>`_ | |||
| `ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM %20AND%20 component %3D ap_verify>`_ | |||
There was a problem hiding this comment.
@mrawls it turns out I wasn't quite right in recommending spaces in URLs -- browsers can handle spaces, but Sphinx deletes them when writing the HTML.
There was a problem hiding this comment.
Well there's a fun mess. There may be a broken link lurking in ap_pipe too, then, but I'm not going to lose sleep over it.
| @@ -14,7 +14,7 @@ Repository | |||
| https://github.com/lsst-dm/ap_verify | |||
|
|
|||
| Jira component | |||
| `ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM AND component %3D ap_verify>`_ | |||
| `ap_verify <https://jira.lsstcorp.org/issues/?jql=project %3D DM %20AND%20 component %3D ap_verify>`_ | |||
There was a problem hiding this comment.
Well there's a fun mess. There may be a broken link lurking in ap_pipe too, then, but I'm not going to lose sleep over it.
| @@ -28,12 +28,26 @@ Organizing the Data | |||
|
|
|||
| * The :file:`raw` and :file:`calib` directories contain science and calibration data, respectively. | |||
| The directories may have any internal structure. | |||
| * The :file:`templates` directory contains an :ref:`LSST Butler repository<butler>` containing processed images useable as templates. | |||
| * The :file:`templates` directory contains an :ref:`LSST Butler repository<butler>` containing processed images usable as templates. | |||
There was a problem hiding this comment.
FUN FACT: both usable and useable are acceptable spellings! (I don't have a preference 😆 ) https://english.stackexchange.com/questions/69709/is-useable-preferred-in-certain-regions-or-just-an-alternate-spelling-of-usa
There was a problem hiding this comment.
Well, my spellchecker disagrees. 🙂
| The dataset's package-level documentation should include: | ||
|
|
||
| * the source of the data (e.g., a particular survey with specific cuts applied) | ||
| * whether or not optional files such as templates are provided |
There was a problem hiding this comment.
"Template" may be a bit overloaded here. Clarify that you mean coadds and/or visits (i.e., template images) for difference imaging when you say templates, please.
There was a problem hiding this comment.
"Image differencing templates"?
kfindeisen
force-pushed
the
tickets/DM-14557
branch
from
1333350
to
1cec3bd
Compare
This PR makes some miscellaneous updates to the dataset docs in
ap_verify. No link needed to be added to the documentation introduced in lsst-dm/legacy-ap_verify_hits2015#7, as broken links to theap_verify_hits2015-packagelabel were already present.