Skip to content

Commit

Permalink
fixed docstrings formatting errors
Browse files Browse the repository at this point in the history
  • Loading branch information
zilto authored and zilto committed Oct 24, 2024
1 parent 87c6a58 commit e6958eb
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions hamilton/caching/stores/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,10 @@ def get_run_ids(self) -> Sequence[str]:
@abc.abstractmethod
def get_run(self, run_id: str) -> Sequence[dict]:
"""Return a list of node metadata associated with a run.
For each node, the metadata should include:
- ``cache_key`` (created or used)
- ``data_version``
This is to allow users to manually query the MetadataStore or ResultStore.
For each node, the metadata should include ``cache_key`` (created or used)
and ``data_version``. These values allow to manually query the MetadataStore
or ResultStore.
Decoding the ``cache_key`` gives the ``node_name``, ``code_version``, and
``dependencies_data_versions``. Individual implementations may add more
Expand Down
6 changes: 3 additions & 3 deletions hamilton/caching/stores/sqlite.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,10 +210,10 @@ def get_run(self, run_id: str) -> List[dict]:
:param run_id: ID of the run to retrieve
:return: List of node metadata which includes ``cache_key``, ``data_version``,
``node_name``, and ``code_version``. The list can be empty if a run was initialized
but no nodes were executed.
``node_name``, and ``code_version``. The list can be empty if a run was initialized
but no nodes were executed.
Raises an ``IndexError`` if the ``run_id`` is not found in metadata store.
:raises IndexError: if the ``run_id`` is not found in metadata store.
"""
cur = self.connection.cursor()
if self._run_exists(run_id) is False:
Expand Down

0 comments on commit e6958eb

Please sign in to comment.