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:
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:
functionality to not work as expected)
Solution:
I made the desired changes to the .rst file to update the documentation.
Changes:
doc_template/aibs_sphinx/static
doc_template/visual_behavior_optical_physiology.rst
to 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
Allen Institute Contribution Guidelines
Numpy Standards
appropriate
rc/x.y.z as its merge target
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)?