diff --git a/doc/api.rst b/doc/api.rst index c565d14cc..aaf698b25 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -30,7 +30,6 @@ The Project Project.fn Project.groupby Project.import_from - Project.id Project.isfile Project.min_len_unique_id Project.num_jobs diff --git a/signac/contrib/job.py b/signac/contrib/job.py index 4126826ec..3b3dd3d6e 100644 --- a/signac/contrib/job.py +++ b/signac/contrib/job.py @@ -911,7 +911,8 @@ def open(self): .. code-block:: python with project.open_job(my_statepoint) as job: - # manipulate your job data + # Manipulate your job data + pass Opening the context will switch into the job's workspace, leaving it will switch back to the previous working directory. diff --git a/signac/core/dict_manager.py b/signac/core/dict_manager.py index d2f845e22..6e8a07ae7 100644 --- a/signac/core/dict_manager.py +++ b/signac/core/dict_manager.py @@ -14,6 +14,11 @@ class DictManager: This class is designed to manage multiple dict-like interface classes to files with a shared prefix (directory). + + Parameters + ---------- + prefix : str + The directory prefix shared by all files managed by this class. """ cls = None diff --git a/signac/core/h5store.py b/signac/core/h5store.py index 53ebe5c59..02c341821 100644 --- a/signac/core/h5store.py +++ b/signac/core/h5store.py @@ -529,19 +529,21 @@ def clear(self): class H5StoreManager(DictManager): """Helper class to manage multiple instances of :class:`~.H5Store` within a directory. - Example (assuming that the 'stores/' directory exists): - - .. code-block:: python - - >>> stores = H5StoreManager('stores/') - >>> stores.data - - >>> stores.data.foo = True - >>> dict(stores.data) - {'foo': True} + Parameters + ---------- + prefix : str + The directory prefix shared by all files managed by this class. - :param prefix: - The directory prefix shared by all stores managed by this class. + Examples + -------- + Assuming that the ``stores/`` directory exists: + + >>> stores = H5StoreManager('stores/') + >>> stores.data + + >>> stores.data.foo = True + >>> dict(stores.data) + {'foo': True} """ cls = H5Store # type: ignore