From dac7d875c4a61ab8d549a33c8618aa53e0d35c8e Mon Sep 17 00:00:00 2001 From: "Andrew S. Rosen" Date: Fri, 9 Feb 2024 21:10:01 -0800 Subject: [PATCH] Fix `JobStore.from_file` docstring Fixes a minor typo I stumbled upon in #542. --- src/jobflow/core/store.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/jobflow/core/store.py b/src/jobflow/core/store.py index 474a7b84..0150201f 100644 --- a/src/jobflow/core/store.py +++ b/src/jobflow/core/store.py @@ -547,7 +547,7 @@ def get_output( @classmethod def from_file(cls: type[T], db_file: str | Path, **kwargs) -> T: """ - Create an JobStore from a database file. + Create a JobStore from a database file. Two options are supported for the database file. The file should be in json or yaml format. @@ -555,7 +555,7 @@ def from_file(cls: type[T], db_file: str | Path, **kwargs) -> T: The simplest format is a monty dumped version of the store, generated using: >>> from monty.serialization import dumpfn - >>> dumpfn("job_store.yaml", job_store) + >>> dumpfn(job_store, "job_store.yaml") Alternatively, the file can contain the keys docs_store, additional_stores and any other keyword arguments supported by the :obj:`JobStore` constructor. The