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

drop markdown for notebook examples? #488

Open
fabianp opened this issue Aug 2, 2023 · 2 comments
Open

drop markdown for notebook examples? #488

fabianp opened this issue Aug 2, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@fabianp
Copy link
Collaborator

fabianp commented Aug 2, 2023

github has now a nice way to diff notebooks (https://github.blog/changelog/2023-03-01-feature-preview-rich-jupyter-notebook-diffs/)

I think we could drop the markdown part of the notebooks (https://jaxopt.github.io/stable/developer.html#update-notebooks), which I think adds an unnecessary overhead for contributors. What do you think @mblondel ?

@mblondel
Copy link
Collaborator

mblondel commented Aug 2, 2023

Sounds reasonable to me.

@jakevdp Any disadvantage?

@jakevdp
Copy link

jakevdp commented Aug 2, 2023

One disadvantage is that github is a bit of an outlier in providing readable diffs for notebooks; in other systems (critique, git diff, etc.) diffs are harder to read, and even with github's nice diffs, notebook merge conflicts are still near impossible to do without corrupting the file.

But having to run jupytext on modified files does create some friction, so I could see the desire to be rid of it.

@fabianp fabianp added the documentation Improvements or additions to documentation label Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants