Skip to content

Commit

Permalink
docs: revise .storage.index.DatabaseIndex.get method docstring
Browse files Browse the repository at this point in the history
Refs #10
  • Loading branch information
Aesonus committed Oct 19, 2024
1 parent 10f7f10 commit d52f6ce
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions alchemical_storage/storage/index.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ def __init__(
self._count_key = count_key

def get(self, **kwargs) -> list[EntityType] | list[sql.Row[EntityType]]:
"""Get a list of resources from storage.
"""Get a list (index) of resources from storage.
Arguments:
**kwargs: Parameters to pass to the statement visitors.
Returns:
List of models or rows.
List of models or rows if entity is a tuple.
"""
if isinstance(self.entity, tuple):
Expand Down

0 comments on commit d52f6ce

Please sign in to comment.