Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix JobStore.from_file docstring #543

Merged
merged 1 commit into from
Feb 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix JobStore.from_file docstring
Fixes a minor typo I stumbled upon in #542.
  • Loading branch information
Andrew-S-Rosen authored Feb 10, 2024
commit dac7d875c4a61ab8d549a33c8618aa53e0d35c8e
4 changes: 2 additions & 2 deletions src/jobflow/core/store.py
Original file line number Diff line number Diff line change
@@ -547,15 +547,15 @@ 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.

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
Loading