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

Add top-level developer documentation #8

Closed
alessandrofelder opened this issue Jun 5, 2023 · 3 comments · Fixed by #144
Closed

Add top-level developer documentation #8

alessandrofelder opened this issue Jun 5, 2023 · 3 comments · Fixed by #144

Comments

@alessandrofelder
Copy link
Member

alessandrofelder commented Jun 5, 2023

Useful for onboarding contributors (both external and the new starters from ARC)!
At least a draft so we have something to work off of.

@alessandrofelder
Copy link
Member Author

Things that should be included:

@alessandrofelder
Copy link
Member Author

alessandrofelder commented Dec 11, 2023

Also document docstring conventions and anything in brainglobe/BrainGlobe#47

And pathlib.Path(__file__).parent versus importlib.resources for test data

@alessandrofelder
Copy link
Member Author

alessandrofelder commented Jan 5, 2024

Taking notes about what should go in here (from zulip topic):

Maybe the convention is that versions 1.x of any BrainGlobe package is part of BrainGlobe v1., and v2.x with version 2 etc?

(but brainrender is already >2...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant