Skip to content
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

update VBO read the docs page #2660

Merged
merged 5 commits into from
Feb 14, 2023
Merged

Conversation

matchings
Copy link
Collaborator

@matchings matchings commented Feb 11, 2023

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:

  • 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)
  • 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.

Checklist

  • My code follows
    Allen Institute Contribution Guidelines
  • [N/A] My code is unit tested and does not decrease test coverage
  • I have performed a self review of my own code
  • 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
  • My Pull Request has the latest AllenSDK release candidate branch
    rc/x.y.z as its merge target
  • 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)?

@aamster aamster changed the base branch from rc/2.15.2 to master February 14, 2023 14:23
@aamster aamster merged commit 1caa779 into AllenInstitute:master Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants