From 7e5ed8558cb6dde0692359cd511ddb00c840a0d3 Mon Sep 17 00:00:00 2001 From: Andy Salnikov Date: Wed, 18 Sep 2024 12:22:18 -0700 Subject: [PATCH] Few fixes for docstrings --- python/lsst/daf/butler/_butler.py | 9 ++++----- python/lsst/daf/butler/queries/_query.py | 7 +++---- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/python/lsst/daf/butler/_butler.py b/python/lsst/daf/butler/_butler.py index d687630b69..0535ae2e96 100644 --- a/python/lsst/daf/butler/_butler.py +++ b/python/lsst/daf/butler/_butler.py @@ -1459,7 +1459,7 @@ def run(self) -> str | None: @property def dataset_types(self) -> ButlerDatasetTypes: """Object with methods for modifying and querying dataset types - (`~lsst.daf.butler.ButlerDatasettypes`). + (`~lsst.daf.butler.ButlerDatasetTypes`). Use of this object is preferred over `registry` wherever possible. """ @@ -1666,7 +1666,7 @@ def query_datasets( Returns ------- - refs : `.queries.DatasetRefQueryResults` + refs : `list` [`DatasetRef`] Dataset references matching the given query criteria. Nested data IDs are guaranteed to include values for all implied dimensions (i.e. `DataCoordinate.hasFull` will return `True`). @@ -1861,10 +1861,9 @@ def _query_all_datasets( at_least_dimensions : `Iterable` [ `str` ] or `DimensionGroup`,\ optional Dimensions that returned dataset types must have as a subset. - at_least_dimensions : `Iterable` [ `str` ] or `DimensionGroup`,\ - optional + exact_dimensions : `Iterable` [ `str` ] or `DimensionGroup`, optional Dimensions that returned dataset types must have exactly. - with_storage_class : `str` or `~collections.abc.Iterable` [ `str` ],\ + storage_class : `str` or `~collections.abc.Iterable` [ `str` ],\ or `StorageClass` or \ `~collections.abc.Iterable` [ `StorageClass` ], optional Storage classes or storage class names that returned dataset types diff --git a/python/lsst/daf/butler/queries/_query.py b/python/lsst/daf/butler/queries/_query.py index c03e8704f2..c6e28d142e 100644 --- a/python/lsst/daf/butler/queries/_query.py +++ b/python/lsst/daf/butler/queries/_query.py @@ -474,10 +474,9 @@ def all_datasets( at_least_dimensions : `Iterable` [ `str` ] or `DimensionGroup`,\ optional Dimensions that returned dataset types must have as a subset. - at_least_dimensions : `Iterable` [ `str` ] or `DimensionGroup`,\ - optional + exact_dimensions : `Iterable` [ `str` ] or `DimensionGroup`, optional Dimensions that returned dataset types must have exactly. - with_storage_class : `str` or `~collections.abc.Iterable` [ `str` ],\ + storage_class : `str` or `~collections.abc.Iterable` [ `str` ],\ or `StorageClass` or \ `~collections.abc.Iterable` [ `StorageClass` ], optional Storage classes or storage class names that returned dataset types @@ -502,7 +501,7 @@ def all_datasets( """ raise NotImplementedError() - def dataset_types( + def dataset_types( # numpydoc ignore=PR01 self, collections: str | Iterable[str] | None = None, *,