Open
Conversation
donald-e-boyce
added
the
documentation
| symHKLs: NDArray | ||
| symHKLs_ix: NDArray | ||
| wavelength: float | ||
| hklList: list[Any] |
Collaborator
There was a problem hiding this comment.
We should really avoid Any if at all possible when typing. Is it safe to assume that hklList is a list of integers, for example? If it can be multiple types, we can address that too, e.g. list[int | float].
Collaborator
ZackAttack614
left a comment
ZackAttack614
left a comment
There was a problem hiding this comment.
This is definitely better! I'll propose that we add in typing for the elements of numpy arrays, as well. We've done that in most places, e.g. here. That allows us to statically analyze the script and know whether the data type is an int, float64, bool, or str - all of which are matrix element types we've worked with in the HEXRD ecosystem.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Overview
See #908, unintentionally closed. This cleans up documentation and typing in indexer.py. The latest changes the
ParamMPvariable to a TypedDict.