-
-
Notifications
You must be signed in to change notification settings - Fork 426
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Replace example data submodule with subtree #2105
Conversation
git-subtree-dir: arviz/data/example_data git-subtree-split: 594a6addd3aeddbd5d03e1a59300a1dcf0491a68
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
We should document somewhere how developers should update the subtree if arviz_example_data is updated: $ git subtree pull --prefix arviz/data/example_data https://github.com/arviz-devs/arviz_example_data.git main --squash Where's a good place for that? |
@ahartikainen thoughts on this question? |
I would say some of the pages in https://python.arviz.org/en/latest/contributing/index.html. Maybe a new one in how-to guides? |
Done! https://arviz--2105.org.readthedocs.build/en/2105/contributing/updating_example_data.html Unless anything on that page needs to change, this should be ready to merge. |
Description
As discussed on Slack, this replaces the git submodule approach with including example data in this repo (#2096) with an approach using git subtree. This makes management slightly more complicated on the developer side but makes it easier whenever one needs to download the repo, as special commands are no longer necessary to clone the repo. See https://stackoverflow.com/questions/31769820/differences-between-git-submodule-and-subtree for some comparisons between the two approaches.
Checklist
📚 Documentation preview 📚: https://arviz--2105.org.readthedocs.build/en/2105/