jaxopt icon indicating copy to clipboard operation
jaxopt copied to clipboard

drop markdown for notebook examples?

Open fabianp opened this issue 2 years ago • 2 comments

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 ?

fabianp avatar Aug 02 '23 06:08 fabianp

Sounds reasonable to me.

@jakevdp Any disadvantage?

mblondel avatar Aug 02 '23 07:08 mblondel

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.

jakevdp avatar Aug 02 '23 16:08 jakevdp