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

[Documentation]: Remove Brain Observatory example #2025

Open
3 tasks done
rly opened this issue Jan 28, 2025 · 0 comments · May be fixed by #2026
Open
3 tasks done

[Documentation]: Remove Brain Observatory example #2025

rly opened this issue Jan 28, 2025 · 0 comments · May be fixed by #2026
Assignees
Labels
topic: dependencies updates to dependencies topic: docs issues related to documentation

Comments

@rly
Copy link
Contributor

rly commented Jan 28, 2025

What would you like changed or added to the documentation and why?

The Allen Brain Observatory gallery tutorial uses the allensdk API to download an NWB file into a cache folder and then creates a new NWB file with the same data step by step. Everything that is demonstrated here is demonstrated in other tutorials, aside from the allensdk API, which is well documented in the allensdk docs.

This example also causes a minor headache with the test harness because it involves installing allensdk which is not well maintained with new versions of python, and it downloads a 450 MB file, which takes some time.

Ref: #1538 (comment)

I propose we remove the example and it looks like @bendichter and @stephprince approve of that. I'll make a quick PR.

Do you have any interest in helping write or edit the documentation?

Yes.

Code of Conduct

@rly rly self-assigned this Jan 28, 2025
@rly rly added topic: docs issues related to documentation topic: dependencies updates to dependencies labels Jan 28, 2025
@rly rly linked a pull request Jan 28, 2025 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: dependencies updates to dependencies topic: docs issues related to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant