Merge pull request #417 from glotzerlab/document-_read_frame-return

Document return type for `_read_frame`
glotzerlab · Jan 30, 2025 · 66590eb · 66590eb
2 parents 07be1df + 84b76ad
commit 66590eb
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -9,6 +9,11 @@ Change Log
 
 3.x
 ---
+next (not yet released)
+^^^^^^^^^^^^^^^^^^^^^^^
+*Fixed:*
+
+* Type hints for ``HoomdTrajectory._read_frame`` and downstream methods are now correct.
 
 3.4.2 (2024-11-13)
 ^^^^^^^^^^^^^^^^^^

diff --git a/doc/credits.rst b/doc/credits.rst
@@ -19,3 +19,4 @@ The following people contributed to GSD.
 * Charlotte Shiqi Zhao, University of Michigan
 * Tim Moore, University of Michigan
 * Joseph Burkhart, University of Michigan
+* Jenna Bradley, University of Michigan
diff --git a/gsd/hoomd.py b/gsd/hoomd.py
@@ -859,7 +859,7 @@ def _read_frame(self, idx):
             idx (int): Frame index to read.
 
         Returns:
-            `Frame` with the frame data
+            Frame : The frame data
 
         Replace any data chunks not present in the given frame with either data
         from frame 0, or initialize from default values if not in frame 0. Cache