From f23895c67ca432a1b5c3e74ace4da7613fc946c2 Mon Sep 17 00:00:00 2001 From: janbridley <55467578+janbridley@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:41:47 -0500 Subject: [PATCH 1/4] Document return type for _read_frame --- gsd/hoomd.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gsd/hoomd.py b/gsd/hoomd.py index 16b4878d..20b16393 100644 --- 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 From 36930abe6a7b32d3876a51530bf8467bb32fbbd7 Mon Sep 17 00:00:00 2001 From: janbridley <55467578+janbridley@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:51:31 -0500 Subject: [PATCH 2/4] Update credits and changelog --- CHANGELOG.rst | 4 ++++ doc/credits.rst | 1 + 2 files changed, 5 insertions(+) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index fd355792..1ad61275 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -10,6 +10,10 @@ Change Log 3.x --- +*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 index 9f2ca59c..bd75eb8d 100644 --- 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 From 709702970d26d9dcf975c0beb47a84f81d988b11 Mon Sep 17 00:00:00 2001 From: janbridley <55467578+janbridley@users.noreply.github.com> Date: Tue, 28 Jan 2025 13:54:20 -0500 Subject: [PATCH 3/4] Double quote method in changelog --- CHANGELOG.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 1ad61275..0a2be661 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -12,7 +12,7 @@ Change Log *Fixed:* -* Type hints for `HoomdTrajectory._read_frame` and downstream methods are now correct. +* Type hints for ``HoomdTrajectory._read_frame`` and downstream methods are now correct. 3.4.2 (2024-11-13) ^^^^^^^^^^^^^^^^^^ From 84b76adf22efffc140b6f71a7dfd9a94845c7c0b Mon Sep 17 00:00:00 2001 From: "Joshua A. Anderson" Date: Thu, 30 Jan 2025 13:48:32 -0500 Subject: [PATCH 4/4] Update CHANGELOG.rst --- CHANGELOG.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 0a2be661..3068c39f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -9,7 +9,8 @@ Change Log 3.x --- - +next (not yet released) +^^^^^^^^^^^^^^^^^^^^^^^ *Fixed:* * Type hints for ``HoomdTrajectory._read_frame`` and downstream methods are now correct.