DM-15872: Incorporate AP documentation into pipelines.lsst.io #48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathansick
approved these changes
Oct 9, 2018
There was a problem hiding this comment.
This looks really solid. I haven't rendered this locally yet, but it seems to hit all the marks.
Just a few bits of feedback that you could consider but aren't necessary at this point:
- For the command
ap_verify.py, I think it'd be good to always writeap_verify.pyto disambiguate from the package name and because that's the command that's actually run. (now why LSST puts extensions on its scripts is another matter for discussion :) ) - Along the same lines, you might want to look at using the
programdomain. This will let you "namespace" the option directives so that they don't conflict with documentation of similarly-named options in other scripts out there.
|
|
||
| In order to be supported by ``ap_verify``, datasets must be registered in ``ap_verify``'s :ref:`configuration file<ap-verify-configuration-dataset>` and registered as an *optional* EUPS dependency of ``ap_verify``. | ||
| In order to be supported by ``ap_verify``, datasets must be registered in ``ap_verify``'s :ref:`configuration file<ap-verify-configuration-dataset>`. |
There was a problem hiding this comment.
Just FYI, possessives of inline syntax often need to be escaped, like this:
``ap_verify``\ ’sI haven't compiled this yet (long story) so I can't say if the rendering is mangled in this case or not.
There was a problem hiding this comment.
It compiles fine. I think it's the single backticks that you need to watch out for.
|
I'm already using |
Dataset pages cannot yet be included in pipelines.lsst.io; link to GitHub repositories instead.
kfindeisen
force-pushed
the
tickets/DM-15872
branch
from
ea8e3a3
to
7702656
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation to current data package conventions (in particular, merging the package and module home pages, and transforming the
.measurementssubpackage documentation into a contributing guide) and fixes build errors detected when building withpipelines_lsst_io.