Skip to content

Commit

Permalink
More minor doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
timj committed Jul 10, 2023
1 parent 8e8c7b4 commit 5c057a8
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions python/lsst/daf/butler/_limited_butler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down
14 changes: 7 additions & 7 deletions python/lsst/daf/butler/_quantum_backed.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions python/lsst/daf/butler/core/datastore.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------
Expand Down
2 changes: 1 addition & 1 deletion python/lsst/daf/butler/core/quantum.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----
Expand Down

0 comments on commit 5c057a8

Please sign in to comment.