Skip to content

Commit

Permalink
Add missing parameter to QuantumGraph constructor docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
kfindeisen committed Apr 13, 2023
1 parent 1ed7fce commit 52e1db3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/changes/DM-36162.doc.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
Loosened documentation of `QuantumGraph.inputQuanta` and `outputQuanta`.
They are not guaranteed to be (and currently are not) lists, so the new documentation describes them as iterables.

Documented `universe` constructor parameter to `QuantumGraph`.
3 changes: 3 additions & 0 deletions python/lsst/pipe/base/graph/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ class QuantumGraph:
Entries in this mapping should be able to be serialized in JSON.
pruneRefs : iterable [ `DatasetRef` ], optional
Set of dataset refs to exclude from a graph.
universe : `lsst.daf.butler.DimensionUniverse`, optional
The dimensions in which quanta can be defined. Need only be provided if
no quanta have data IDs.
initInputs : `Mapping`, optional
Maps tasks to their InitInput dataset refs. Dataset refs can be either
resolved or non-resolved. Presently the same dataset refs are included
Expand Down

0 comments on commit 52e1db3

Please sign in to comment.