From 2eb73806afdad87732fb188f1d97fd3c293a738d Mon Sep 17 00:00:00 2001 From: Tim Jenness Date: Mon, 10 Jul 2023 13:57:11 -0700 Subject: [PATCH] More minor doc fixes --- python/lsst/daf/butler/_limited_butler.py | 4 ++-- python/lsst/daf/butler/_quantum_backed.py | 14 +++++++------- python/lsst/daf/butler/core/datastore.py | 4 ++-- python/lsst/daf/butler/core/quantum.py | 2 +- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/python/lsst/daf/butler/_limited_butler.py b/python/lsst/daf/butler/_limited_butler.py index f2300a544e..e14929280f 100644 --- a/python/lsst/daf/butler/_limited_butler.py +++ b/python/lsst/daf/butler/_limited_butler.py @@ -383,8 +383,8 @@ def get_many_uris( If the datastore does not know about a dataset, should it return a predicted URI or not? allow_missing : `bool` - If `False`, and ``predict`` is `False`, will raise if a `DatasetRef` - does not exist. + If `False`, and ``predict`` is `False`, will raise if a + `DatasetRef` does not exist. Returns ------- diff --git a/python/lsst/daf/butler/_quantum_backed.py b/python/lsst/daf/butler/_quantum_backed.py index 6219522c36..62c33eaa56 100644 --- a/python/lsst/daf/butler/_quantum_backed.py +++ b/python/lsst/daf/butler/_quantum_backed.py @@ -604,8 +604,8 @@ class QuantumProvenanceData(BaseModel): Notes ----- This class slightly duplicates information from the `Quantum` class itself - (the `predicted_inputs` and `predicted_outputs` sets should have the same - IDs present in `Quantum.inputs` and `Quantum.outputs`), but overall it + (the ``predicted_inputs`` and ``predicted_outputs`` sets should have the + same IDs present in `Quantum.inputs` and `Quantum.outputs`), but overall it assumes the original `Quantum` is also available to reconstruct the complete provenance (e.g. by associating dataset IDs with data IDs, dataset types, and `~CollectionType.RUN` names. @@ -628,20 +628,20 @@ class QuantumProvenanceData(BaseModel): """Unique IDs of input datasets that were actually present in the datastore when this quantum was executed. - This is a subset of `predicted_inputs`, with the difference generally being - datasets were `predicted_outputs` but not `actual_outputs` of some upstream - task. + This is a subset of ``predicted_inputs``, with the difference generally + being datasets were ``predicted_outputs`` but not ``actual_outputs`` of + some upstream task. """ actual_inputs: set[uuid.UUID] """Unique IDs of datasets that were actually used as inputs by this task. - This is a subset of `available_inputs`. + This is a subset of ``available_inputs``. Notes ----- The criteria for marking an input as used is that rerunning the quantum - with only these `actual_inputs` available must yield identical outputs. + with only these ``actual_inputs`` available must yield identical outputs. This means that (for example) even just using an input to help determine an output rejection criteria and then rejecting it as an outlier qualifies that input as actually used. diff --git a/python/lsst/daf/butler/core/datastore.py b/python/lsst/daf/butler/core/datastore.py index ff415276a1..971d858a6f 100644 --- a/python/lsst/daf/butler/core/datastore.py +++ b/python/lsst/daf/butler/core/datastore.py @@ -789,8 +789,8 @@ def getManyURIs( If the datastore does not know about a dataset, should it return a predicted URI or not? allow_missing : `bool` - If `False`, and `predict` is `False`, will raise if a `DatasetRef` - does not exist. + If `False`, and ``predict`` is `False`, will raise if a + `DatasetRef` does not exist. Returns ------- diff --git a/python/lsst/daf/butler/core/quantum.py b/python/lsst/daf/butler/core/quantum.py index 7705a4f4aa..a488cdf448 100644 --- a/python/lsst/daf/butler/core/quantum.py +++ b/python/lsst/daf/butler/core/quantum.py @@ -524,7 +524,7 @@ def inputs(self) -> NamedKeyMapping[DatasetType, tuple[DatasetRef]]: def outputs(self) -> NamedKeyMapping[DatasetType, tuple[DatasetRef]]: """Return mapping of output datasets (to be) generated by this quantum. - Has the same form as `predictedInputs`. + Has the same form as ``predictedInputs``. Notes -----