This PR is an update to the visual_behavior_optical_physiology.rst file that generates the content at https://allensdk.readthedocs.io/en/latest/visual_behavior_optical_physiology.html. The dataset description was not updated after the second data release in August of 2021 and was missing critical information about the VisualBehaviorMultiscope4areasx2d dataset. In addition, several of the key schematics have been updated and improved since 2021.
Type of Fix:
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
[x] Documentation Change
Solution:
I made the desired changes to the .rst file to update the documentation.
Changes:
Added 8 png images to doc_template/aibs_sphinx/static
Edited text of doc_template/visual_behavior_optical_physiology.rst to display these images, along with some rearrangement of the dataset descriptions
Validation:
If it is possible to test the .rst file prior to merging the change, I would be happy to review the content to make sure that everything is displayed properly.
[N/A] My code is unit tested and does not decrease test coverage
[x] I have performed a self review of my own code
[x] My code is well-documented, and the docstrings conform to
Numpy Standards
[N/A] I have updated the documentation of the repository where
appropriate
[N/A] The header on my commit includes the issue number
[x] My Pull Request has the latest AllenSDK release candidate branch
rc/x.y.z as its merge target
[x] My code passes all AllenSDK tests
Notes:
It would be greatly appreciated if these changes could be tested and incorporated ASAP as we will be posting the Visual Behavior Ophys platform paper on bioRxiv very soon (in a few days) and it will include the link to the read the docs page, which will (hopefully) increase page views in the coming weeks. It would be best if the information on the page were accurate for potential new users.
I made the PR against the rc branch because that is what the checklist said to do, but perhaps it would be better to give it its own branch so that it can be independent from other ongoing work (and thus incorporated and deployed more quickly)?
Overview:
This PR is an update to the
visual_behavior_optical_physiology.rstfile that generates the content at https://allensdk.readthedocs.io/en/latest/visual_behavior_optical_physiology.html. The dataset description was not updated after the second data release in August of 2021 and was missing critical information about the VisualBehaviorMultiscope4areasx2d dataset. In addition, several of the key schematics have been updated and improved since 2021.Type of Fix:
Solution:
I made the desired changes to the .rst file to update the documentation.
Changes:
doc_template/aibs_sphinx/staticdoc_template/visual_behavior_optical_physiology.rstto display these images, along with some rearrangement of the dataset descriptionsValidation:
If it is possible to test the .rst file prior to merging the change, I would be happy to review the content to make sure that everything is displayed properly.
Checklist
Notes:
It would be greatly appreciated if these changes could be tested and incorporated ASAP as we will be posting the Visual Behavior Ophys platform paper on bioRxiv very soon (in a few days) and it will include the link to the read the docs page, which will (hopefully) increase page views in the coming weeks. It would be best if the information on the page were accurate for potential new users.
I made the PR against the rc branch because that is what the checklist said to do, but perhaps it would be better to give it its own branch so that it can be independent from other ongoing work (and thus incorporated and deployed more quickly)?