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 a pre-commit hook for jupytext #19

Closed
gtca opened this issue May 3, 2022 · 5 comments
Closed

Add a pre-commit hook for jupytext #19

gtca opened this issue May 3, 2022 · 5 comments
Assignees
Milestone

Comments

@gtca
Copy link
Collaborator

gtca commented May 3, 2022

After #9 and #12 are merged.
See https://jupytext.readthedocs.io/en/latest/using-pre-commit.html.

@grst
Copy link
Collaborator

grst commented May 5, 2022

What would be the purpose? I just .gitignore the ipynb files and jupytext anyway syncs them every time a notebook is saved.

@gtca
Copy link
Collaborator Author

gtca commented May 5, 2022

scanpy, muon, scvi-tools all use rendered .ipynb notebooks. As I understand, we want to keep this opportunity, especially for the large workflows, where we don't want to or can't rerun them regularly. So we can't just gitignore them?

The idea behind this was, I believe, to also have rendered .ipynb files. Or maybe just providing the guidance for setting up jupytext might be enough. I guess you could lead the best practices here if you're already using it.
Also, don't we need to sync .md and .ipynb files also in case .md files were modified? I can see how this is not an issue if .ipynb files are ignored.

@grst
Copy link
Collaborator

grst commented May 5, 2022

I understand why in some cases the ipynb files are needed, but in that case why not just add the ipynb files and not bother with jupytext at all?

It could be nice for code-reviews though...

@grst grst added this to the v0.2.0 milestone Jul 9, 2022
@grst grst self-assigned this Jul 9, 2022
@grst
Copy link
Collaborator

grst commented Jul 9, 2022

Best to implement this together with #40.

@grst
Copy link
Collaborator

grst commented Apr 27, 2023

Closing in favor of #40

@grst grst closed this as completed Apr 27, 2023
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

No branches or pull requests

2 participants