AllenInstitute / AllenSDK

code for reading and processing Allen Institute for Brain Science data
https://allensdk.readthedocs.io/en/latest/
Other
343 stars 149 forks source link

Provide accurate documentation for brain_observatory_cache.get_eye_tracking #2740

Open chaseking opened 8 months ago

chaseking commented 8 months ago

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:

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

Notes:

CLAassistant commented 8 months ago

CLA assistant check
All committers have signed the CLA.