Provide accurate documentation for brain_observatory_cache.get_eye_tracking#2740
Open
chaseking wants to merge 5 commits intoAllenInstitute:rc/2.16.3from
Open
Provide accurate documentation for brain_observatory_cache.get_eye_tracking#2740chaseking wants to merge 5 commits intoAllenInstitute:rc/2.16.3from
chaseking wants to merge 5 commits intoAllenInstitute:rc/2.16.3from
Conversation
saskiad
approved these changes
Jan 8, 2024
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
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:
I was involved in generating eye tracking files and packaging them into a format that can be used in the BrainObservatoryCache. I noticed the method to access these data did not have proper documentation; this commit gives the method proper documentation to ensure the user knows what the method returns.
Type of Fix:
functionality to not work as expected)
Solution:
Implements correct documentation for the method
Changes:
Documentation on the get_eye_tracking method in brain_observatory cache is amended to describe the returned data array. Changes are entirely in method documentation comments and thus unit tests are not needed.
Validation:
N/A
Checklist
Allen Institute Contribution Guidelines
Numpy Standards
appropriate
rc/x.y.z as its merge target
Notes: