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

Use git hash rather than branch name in the jupyter notebook header #260

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

pkienzle
Copy link
Member

@pkienzle pkienzle commented Feb 26, 2025

I'm not sure which is better: point to the latest version of the notebook (the current code), or point to the version of the notebook at the time the document was created (the new code).

@bmaranville
Copy link
Member

If we only rebuild the docs on releases, and we also publish to pypi on every release, then the notebooks can generically use %pip install refl1d and it should "just work" because the most recent package corresponds to the current docs.

I think that also means we should also use the tag or hash in the link to pin the notebook, as a newer notebook being prepared for an upcoming release may not be compatible with the current release.

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

Successfully merging this pull request may close these issues.

2 participants