search

tBuLi / symfit

Symbolic Fitting; fitting as it should be.
http://symfit.readthedocs.org
MIT License
233 stars 17 forks source link

Notebooks in documentation #242

Closed tBuLi closed 5 years ago

tBuLi commented 5 years ago

Support notebooks in our documentation. This makes writing examples a lot simpler and more beautiful.

pckroon commented 5 years ago

What I don't like about this is that it's much harder to review the changes to the ipynb files, but I'll live with it. And please leave the plain .py files in /examples --- they're easier to find and quickly glance over IMHO.

tBuLi commented 5 years ago

I agree that notebooks really suck when you try to diff them. A workaround would be to view them directly using github, like here. However, still not a diff of course, but readable at least.

But I do think the advantages are good selling points, they're pretty much self testing, and they are easy and quick to write which lowers the threshold to writing examples, not to mention a lot of users probably work in notebooks.