DM-11597: Integration in pipelines.lsst.io docs #16
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
The package documentation system no longer relies on README and requirements.txt to setup an ad hoc Sphinx build.
This is the templated boilerplate for package documentation. The manifest declares lsst.verify **module** documentation and verify **package** documentation directories.
SimonKrughoff
approved these changes
Aug 26, 2017
python/lsst/verify/jobmetadata.py
Outdated
| Parameters | ||
| ---------- | ||
| data : `dict`-like | ||
| The ``data`` object need to provide an ``items`` method it |
There was a problem hiding this comment.
need -> needs
it -> to ?
python/lsst/verify/measurement.py
Outdated
| ``extras`` work just like `Blob`\ s, but they're automatically created with | ||
| each `Measurement`. Add `~lsst.verify.Datum`\ s to ``extras`` if those | ||
| `~lsst.verify.Datum`\ s only make sense in the context of that | ||
| `Measurement`. If `Datums`\ s are relevant to multiple measurement, add |
python/lsst/verify/measurement.py
Outdated
|
|
||
| These key-value pairs are automatically available from `Job.meta`, | ||
| though keys are prefixed with the `Metric`\ 's name. This metadata can | ||
| be queried by `Specification`\ s, so that `Specification` \s can be |
python/lsst/verify/measurementset.py
Outdated
| @@ -30,7 +30,11 @@ | |||
|
|
|||
|
|
|||
| class MeasurementSet(JsonSerializationMixin): | |||
| """A collection of measurements of metrics. | |||
| """A collection of `~lsst.verify.Measurement` s of | |||
There was a problem hiding this comment.
do you need the escaping ?
python/lsst/verify/metric.py
Outdated
| Units of the metric. `Measurements` of this metric must be in an | ||
| equivalent (i.e. convertable) unit. Argument can either be a | ||
| `~astropy.unit.Unit` instance, or a an astropy.unit.Unit-compatible | ||
| Units of the metric. `~lsst.verify.Measurements` of this metric must be |
There was a problem hiding this comment.
Measurements -> Measurement\ s?
python/lsst/verify/specset.py
Outdated
| exist in this set are added to this one. Specification in ``other`` | ||
| replace specifications of the same name in this one. | ||
| Another `SpecificationSet`. `Specification`\ s in ``other`` that do | ||
| exist in this set are added to this one. `Specification`\ s in |
This is a sweep through the docstrings to fix obvious errors and typos. The fixes are mostly to add missing docstrings, improve code links, and fix formatting issues.
jonathansick
force-pushed
the
tickets/DM-11597
branch
from
a9da19c
to
6c5e70d
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 integrates
verifyandlsst.verifyinto the pipelines.lsst.io documentation build.validate_base(alas, new user guides need to be written forlsst.verifystill).Homepage for
verifypackage: https://pipelines.lsst.io/v/DM-11597/packages/verify/index.htmlHomepage for
lsst.verifymodule: https://pipelines.lsst.io/v/DM-11597/modules/lsst.verify/index.html