Document return type for _read_frame
#417
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The return type of the
_read_frame
function was added to theReturns
docstring block to eliminate a warning raised by type hinters.Motivation and Context
Python type linters would make the incorrect assumption that
__getitem__
from a trajectory always returned aHoomdTrajectoryView
, even through__getitem__
with an int returns a gsd frame. This would lead to warnings likeCannot access attribute "particles" for class "_HOOMDTrajectoryView"
when attempting to access properties that do not exist in a trajectory view. Updating the return type in the documentation of_read_frame
fixes this issue.How Has This Been Tested?
The warning is no longer raised.
Checklist:
doc/credits.rst
) in the pull request source branch.CHANGELOG.rst
.