diff --git a/changelog.txt b/changelog.txt index db7908c22..ab014664f 100644 --- a/changelog.txt +++ b/changelog.txt @@ -14,7 +14,7 @@ Added +++++ - Official support for Python 3.12 (#957). - - ``Job.statepoint_mapping`` - cached and read only access to job statepoints. Faster than + - ``Job.cached_statepoint`` - cached and read only access to job statepoints. Faster than ``Job.statepoint`` (#975). Changed diff --git a/doc/api.rst b/doc/api.rst index 4a89a5a55..41734ed39 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -78,6 +78,7 @@ The Job class .. autosummary:: + Job.cached_statepoint Job.clear Job.close Job.data diff --git a/signac/job.py b/signac/job.py index 5bd169126..ba071eb46 100644 --- a/signac/job.py +++ b/signac/job.py @@ -424,8 +424,8 @@ def cached_statepoint(self): .. note:: Create and update the statepoint cache by calling - :py:meth:`Project.update_cache` or running``signac update-cache`` on the - command line. + :py:meth:`project.update_cache ` + or running ``signac update-cache`` on the command line. .. seealso:: @@ -453,7 +453,8 @@ def statepoint(self): .. tip:: - Use :py:attr:`cached_statepoint` for fast access to read the statepoint. + Use :py:attr:`cached_statepoint` for fast read-only access to the + statepoint. .. warning::