Doc fixes.

glotzerlab · Feb 9, 2024 · 32b8fa9 · 32b8fa9
1 parent f02beb5
commit 32b8fa9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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 <signac.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::