-
Notifications
You must be signed in to change notification settings - Fork 191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add get_channel_locations
to the base recording api
#3403
Add get_channel_locations
to the base recording api
#3403
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small tweaks :)
axes: "xy" | "yz" | "xz" = "xy", | ||
) -> np.ndarray: | ||
""" | ||
Get the physical locations of specified channels. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is likely improvement enough for merging, but since contact vs channel is still a point of confusion for many users we may want to workshop better ways to talk about channel_locations for public functions.
Co-authored-by: Zach McKenzie <[email protected]>
Co-authored-by: Zach McKenzie <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like I said my other point was more for us to think about long-term. This PR is a great doc improvement.
This will make the method appear on the BaseRecording API on the docs.
Plus, I added a docstring to the method.
No changes on behavior with this diff.