From e6958eb0dba485cb3f5cc5d4042e91766fe2b5bc Mon Sep 17 00:00:00 2001 From: zilto Date: Thu, 24 Oct 2024 15:22:31 -0400 Subject: [PATCH] fixed docstrings formatting errors --- hamilton/caching/stores/base.py | 8 ++++---- hamilton/caching/stores/sqlite.py | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/hamilton/caching/stores/base.py b/hamilton/caching/stores/base.py index 9367f6995..98eda2f5a 100644 --- a/hamilton/caching/stores/base.py +++ b/hamilton/caching/stores/base.py @@ -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 diff --git a/hamilton/caching/stores/sqlite.py b/hamilton/caching/stores/sqlite.py index a4635f540..4ad0eb480 100644 --- a/hamilton/caching/stores/sqlite.py +++ b/hamilton/caching/stores/sqlite.py @@ -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: