Skip to content

Commit

Permalink
Few fixes for docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
andy-slac committed Sep 18, 2024
1 parent a4ff2a4 commit 7e5ed85
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
9 changes: 4 additions & 5 deletions python/lsst/daf/butler/_butler.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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`).
Expand Down Expand Up @@ -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
Expand Down
7 changes: 3 additions & 4 deletions python/lsst/daf/butler/queries/_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
*,
Expand Down

0 comments on commit 7e5ed85

Please sign in to comment.